七乐康商务代表接口v1

1、商务代表接口文档版本号：1.3文档： 2015-06-131.0Create创建文档。2015-06-171.1Add补充文档2015-06-211.3Add补充修改文档目录Change History1引言4接口规范4协议42.2.地址42.3.公共参数42.4.返回值43.接口详细说明53.1.登录页53.1.1.发送(/忘记) 53.1.2.商务代表 53.1.3.判断用户是否 63.2.医生管理7医生列表73.2.1.提醒医生补充资料8积分8获取积分信息..申请提现93.3.2.个人列表9列表103.3.3.系统已支持3.3.4.录入103.3.5.积分历

2、史3.3.6. 11积分详情(3.3.7.) 12提现3.3.8. 123.4.个人中心133.4.1.个人基本信息查询133.4.2.个人基本信息修改143.4.3.城市字典查询143.4.4.获取用户 154.附录164.1.关于异常状态码定义的建议161. 引言本文档用于描述商务代表值说明等内容。服务接口规范，主要包括：网络传输协议、数据传输协议,参数及返回2. 接口规范2.1. 协议接口基于HTTP 协议，支持GET/T 请求，以JSON 格式返回数据。2.2. 地址接口地址为(测试)：接口地址为(正式)：2.3. 公共参数2.4. 返回值返回值的基本结构如下：code:,“msg”:

3、”, data:,返回值结构描述属性含义取值code本次请求状态码0：表示成功；其他数字表示异常。msg状态码对应的信息状态码对应的提示信息。data业务相关数据JSON 数组。不同接口返回的JSON 数据对象参数名参数含义必选取值_pY1：andorid / 2：_v客户端版本号Y格式：例如：1.0.0_m设备的mac 地址Y_cJSONP 的回调函数名N说明：如上参数为公共参数，请在Http Header 中传递3. 接口详细说明3.1. 登录页3.1.1. 发送/忘记()3.1.2. 商务代表描述点击图新用户用户用户在此页面输入、号、号，之后点击调用此接口进行用户注册。地址(正式)地址(

4、测试)参数参数名类型必须备注nameY用户真实(长度过 10)phoneNumY号verifyCodeY(用户点击获取通过收到)mendNumN商务号(商务自有)(非必须项)openIdYopenIdheadUrlY商务代表头像sourceTypeY此代表来源(1/代表发展而来，下面的parentId 表示父级ID)；2/其他来源描述用户在或忘记时需要发送进行认证，调此接口进行下发(注：发送失败情况可能存在示例情况：今日发送量已达上限/运营商业务繁忙 等)。地址(正式)地址(测试)参数参数名类型必须备注phoneNumY用户输入号码actionTypeY功能类型(1/；2/忘记；3/修改号。功

5、能类型不同生成规则不同)方法T响应成功data: ,msg: sucs, code: 0消息提示：sucs；(示例：发送失败/)结果码：0/发送成功；非 0(1,2,3)/失败失败code 的值不为 0 的时候，请直接显示msg 的值备注3.1.3. 判断用户是否描述使用标识号码判断用户是否已经地址(正式)地址(测试)参数参数名类型必须备注openIdY用户openId方法T响应成功code: 0,msg: sucs, data: id:123realName: , phoneNum:1366114 mendNum:12,company: 二院,areaName:，areaId:001结果码：

6、113/未，data 节点为空； 114/此已经 ，data 节点返回已账户信息；非 0,1(2,3)/失败消息提示：(示例：错误/号不规则)商务代表ID真实号号公司名称地区名称地区ID失败code 的值不为 0 的时候，请直接显示msg 的值备注parentIdN父级ID(此商务代表是被此 ID 对应商务代表发展而来)方法T响应成功data: ,msg: sucs, code: 0消息提示：(示例：错误/号不规则)结果码：0/成功；非 0(1,2,3)/失败失败code 的值不为 0 的时候，请直接显示msg 的值备注3.2. 医生管理3.2.1. 医生列表描述医生管理医生列表(商务代表自己

7、发展的医生列表)地址(正式)地址(测试)参数参数名类型必须备注busineY商务代表 idpageY页码numN每页数（不填默认）方法GET/T响应成功data: result: name: , level: 0,departmentId: 1,hospitalId:11,expertise:专业, hide:0,userId:123,totalCount: 1,totalPages: 1,msg: sucs, code: 0职级。0：主治医师；1：部门id医院专长与专业是否隐身，隐身的话不会被搜到，不隐身可以被所有人搜到。0：不隐身；1：隐身用户ID(医生ID)消息提示：sucs，(示例：未

8、知错误 /)结果码：0/成功；非 0(1,2,3)/失败失败code 的值不为 0 的时候备注3.2.2. 提醒医生补充资料3.3.积分3.3.1. 获取积分信息描述积分-积分统计地址(正式)地址(测试)参数参数名类型必须备注busineY商务代表 ID方法GET/T响应成功code: 0,msg: sucs, data: canMentionPo: 500,totalPo:800,grandMention: 1000,可提现积分账户总积分累计提现失败code 的值不为 0 的时候，请直接显示msg 的值备注描述医生管理医生列表提醒补充资料地址(正式)地址(测试)参数参数名类型必须备注busi

9、neY商务代表IDdoctorIdY医生 ID方法T响应成功data: ,msg: sucs, code: 0消息提示：sucs；(示例：提示失败/)结果码：0/发送成功；非 0(1,2,3)/失败失败code 的值不为 0 的时候，请直接显示msg 的值备注3.3.2. 申请提现3.3.3. 个人列表描述积分-提现页面-点击提现-点击储蓄卡出可选列表（是否需要行信息有待确认地址(正式)地址(测试)参数参数名类型必须备注userIdY用户userTypeY用户类型(0,商务代表；1,医生)方法GET/T响应成功code: 0,msg: sucs, data: name: ,bName:工行bC

10、ardNum:6222,bCode: 1024用户名称号行描述积分-提现地址(正式)地址(测试)参数参数名类型必须备注busineY商务代表 IDmentionMonY提现金额bCardIdY关联表(b_card)主键poY提现积分方法T响应成功data: ,msg: sucs, code: 0消息提示：sucs；(示例：提示失败/)结果码：0/申请成功；非 0(1,2,3)/失败失败code 的值不为 0 的时候，请直接显示msg 的值备注3.3.4. 系统已支持列表录入3.3.5.描述积分-提现页面-点击提现-点击储蓄卡里的使用新卡-添加用户新的地址(正式)地址(测试)参数参数名类型必须备

11、注userIdY用户ID(医生 ID，或商务代表 ID)nameY用户真实bIdY()bCardNumY号userTypeY用户类型(0,商务代表；1,医生)方法T响应成功data: ,msg: sucs, code: 0消息提示：sucs；(示例：录入失败/)结果码：0/录入成功；非 0(1,2,3)/失败描述用户新增过程中选择使用地址(正式)地址(测试)参数参数名类型必须备注方法GET/T响应成功data: bId: 10001,bName: 100.00,createdAt:20150616,msg: sucs, code: 0名称创建时间失败code 的值不为 0 的时候，请直接显示m

12、sg 的值备注失败code 的值不为 0 的时候，请直接显示msg 的值备注3.3.6. 积分历史描述积分-积分历史地址(正式)地址(测试)参数参数名类型必须备注busineY商务代表 IDpageY页码numN每页数（不填默认）方法GET/T响应成功data: result: id: 222,userId: 111,name: , createdTime: 20150617,sus: 0,egralNum: 0,doctorId: 0 actionId,totalCount: 1,totalPages: 1,msg: sucs, code: 0积分历史表积分ID商务代表ID作对象的用户名创建

13、时间状态(0,冻结；1,可提现；2，申请提现；3，已提现；4,已到账）涉及积分数被医生APP 的医生ID关联操作ID总数总页数失败code 的值不为 0 的时候，请直接显示msg 的值备注失败code 的值不为 0 的时候，请直接显示msg 的值备注3.3.7. 积分详情()3.3.8. 提现描述积分-提现地址(正式)地址(测试)参数参数名类型必须备注userIdY提现用户pageY页码numN每页数（不填默认）useTypeY用户类型(0,商务代表；1,医生)方法GET/T响应成功data: 描述积分-积分历史-点开具体的一条积分进入详情页地址(正式)地址(测试)参数参数名类型必须备注idY

14、积分ID方法GET/T响应成功data: id: 222,userId: 111,name: ,remark: 备注, auditPassTime: 0,regisTime: 0,sus: 0,egralNum: 0,doctorId: 0,msg: sucs, code: 0积分ID商务代表ID被医生APP 的用户名备注审核通过时间时间状态(0,冻结；1,已到账）累计积分被医生APP 的医生I失败code 的值不为 0 的时候，请直接显示msg 的值备注3.4. 个人中心3.4.1. 个人基本信息查询描述个人中心-基本信息地址(正式)地址(测试)参数参数名类型必须备注busineY商务代表i

15、d方法GET/T响应成功data: id: 222,realName: ,phoneNum: 136,用户ID真实号码result: id: 222,createdTime:201506 extraMoney: 20,examSus: 0,settleSus: 0, reason: 不对,userId: 567,totalCount: 1,totalPages: 1,msg: sucs, code: 0提现ID创建时间 提现金额审核状态(0,审核通过；1,核不通过； 2, 财务审核通过；3,财务审核不通过)结算状态(0,转账失败；1,已打款)结算确认时间申请人ID失败code 的值不为 0 的

16、时候，请直接显示msg 的值备注3.4.2. 个人基本信息修改3.4.3. 城市 k 查询描述个人中心-基本信息-更改地区(供修改时候进行地区选择使用)地址(正式)地址(测试)参数参数名类型必须备注方法GET/T响应成功code: 0,描述个人中心-基本信息-编辑地址(正式)地址(测试)参数参数名类型必须备注busineY商务代表 IDrealNameN真实phoneNumN号码cityIdN地区 ID方法T响应成功code: 0,msg: sucs,data: 结果码：0/修改成功；非 0(1,2,3)/失败消息提示：sucs；(示例：修改失败/)失败code 的值不为 0 的时候，请直接显

17、示msg 的值备注mendNum: 88,company: 腾讯,areaName: 广州,cityId: 378,openId: 606,msg: sucs, code: 0号 公司地区(城市)地区IDID失败code 的值不为 0 的时候，请直接显示msg 的值备注3.4.4. 获取用户待确认描述获取商务代表和医生，供商务代表商务代表、商务代表医生、医生医生、医生患者使用地址(正式)msg: 成功, data: id: 1,name: 山西省,fullName: ,山西省,type: 1,parentId: 0, available: true, createdBy: null, crea

18、tedAt: null, changedBy: null, changedAt: null, ver: 0,sunList: id: 35,name: 太原市,fullName: ,山西省,太原市,type: 2,parentId: 1, available: true, createdBy: null, createdAt: null, changedBy: admin, changedAt:2014-10-28 20:45:39,ver: 0, sunList: null城市字典ID省 市 区 名称省市区全名类型:0:1:省 2;市父类ID是否有效创建人 创建时间修改人 修改时间版本号子级列表(注释同上)