大白云诊-CMS后台管理服务端接口文档.doc

大白云诊-CMS端文档版本号：1.0文档编号：Change HistoryDateVerChange TypeChange DescriptionsPerson2015-11-251.0CMS-1.5需求2016-03-242.3.0Add添加商务代表公司配置接口3.7.4刘德龙2016-03-242.3.0Add添加商务代表公司列表接口3.7.5刘德龙2016-03-252.3.0Add添加公告主题列表3.12.7蔺海凤2016-03-252.3.0Update修改系统公告列表搜索接口（3.12.2）、修改系统公告（新增/保存）接口（3.12.4）蔺海凤2016-4-12.3.0Update修改活动新增/编辑接口，修改活动详情接口，修改活动列表接口蔺海凤目录Change History1目录21. 引言52. 接口规范52.1. 协议52.2. 地址52.3. 参数示例52.4. 返回值63. 接口详情63.1. 医生相关接口63.1.1. 医生认证审核状态列表63.1.2. 医生搜索列表73.1.3. 医生列表导出Excel93.1.4. 医生基本信息编辑93.1.5. 医生认证审核接口113.1.6. 标识、取消标识医生113.1.7. 禁用医生账户113.1.8. 医生基本信息编辑能否保存123.2. 商务代表相关接口123.2.1. 商务代表数量汇总信息133.2.2. 商务代表搜索列表133.2.3. 商务代表列表导出Excel143.2.4. 商务代表个人基本信息编辑153.2.5. 商务代表禁用、启用163.3. 患者相关接口163.3.1. 标识测试患者163.3.2. 患者诊金基本信息+患者诊金明细列表(含搜索)173.3.3. 患者基本信息编辑183.3.4. 患者禁用、启用203.4. 积分调整203.4.1. 积分详情-积分汇总信息203.4.2. 积分明细-分页查询213.4.3. 积分审核-分页查询223.4.4. 积分审核-审核详情233.4.5. 积分审核-申请修改类型243.4.6. 积分审核-申请修改253.4.7. 积分审核-审核记录253.5. 结算管理263.5.1. 结算审核详情263.5.2. 结算订单详情283.5.3. 客服、财务审核操作接口283.5.4. 人工审核293.5.5. 结算确认293.5.6. 结算列表搜索303.5.7. 结算列表导出Excel313.5.8. 代表积分明细列表323.5.9. 代表积分明细列表导出Excel333.5.10. 医生结算积分列表343.5.11. 积分列表导出Excel(医生,阳光化2.2用于线下结算)353.6. 意见反馈363.6.1. 患者意见反馈列表363.6.2. 患者意见处理结果列表373.6.3. 处理患者意见383.7. 配置管理383.7.1. 医院列表393.7.2. 医院详情403.7.3. 新增/编辑医院403.7.4. 新增商务代表公司413.7.5. 商务代表公司列表413.8. 基础参数数据423.8.1. 医院等级423.8.2. 地区树433.8.3. 患者意见状态列表443.8.4. 业务区域列表453.8.5. 获取标签配置453.8.6. 公司列表（商务代表）463.9. 商务销售工具463.9.1. 商务代表直属下级列表473.9.2. 新增下级下拉框商务列表(包含搜索)473.9.3. 判断商务代表是否已经存在上级483.9.4. 商务代表新增下级493.9.5. 商务代表平级、下级、新员工商代列表493.9.6. 商务代表下级变更503.9.7. 新员工搜索513.9.8. 商务代表下级删除513.10. 医生诊金(阳光化)523.10.1. 医生诊金价格调整523.10.2. 医生诊金设置基本信息+医生诊金调整记录列表523.10.3. 医生诊金基本信息+医生诊金明细列表543.11. 诊金结算(阳光化)563.11.1. 诊金结算列表搜索573.11.2. 结算列表导出Excel583.11.3. 诊金结算列表审核详情593.11.4. 诊金结算客服、财务审核操作接口603.11.5. 诊金结算人工审核操作接口613.11.6. 诊金结算结算确认接口(批量操作)623.12. 系统公告设置（阳光化）623.12.1. 系统公告数量汇总信息623.12.2. 系统公告列表搜索633.12.3. 系统公告预览643.12.4. 系统公告保存（新增/编辑）653.12.5. 系统公告删除663.12.6. 系统公告操作（停止、启用）663.12.7. 系统公告主题列表查询接口663.13. 内容发布管理（阳光化）673.13.1. 系统活动新增、编辑673.13.2. 查看系统活动详情683.13.3. 系统活动暂停、启动693.13.4. 系统活动数量汇总信息693.13.5. 系统活动列表搜索703.13.6. 系统活动删除713.14. 第三方接入搜药需求723.14.1. 订单列表接口（改造原有订单列表接口）722.4.1. 订单商品信息详情（改造原有订单列表接口）733.14.2. 第三方合作商列表接口753.14.3. 第三方合作商新增接口763.14.4. 第三方合作商编辑接口773.14.5. 第三方订单查询列表接口773.14.6. 第三方订单详情接口792.4.2. 订单商品信息详情803.14.7. 第三方结算记录列表接口813.14.8. 第三方结算记录新增接口823.14.9. 第三方结算记录修改接口823.14.10. 第三方结算记录删除接口833.15. 医生管理(商代专用)833.15.1. 商代下级医生搜索列表833.15.2. 商代下级医生详情843.15.3. 商代下级医生基本信息编辑853.15.4. 商代下级医生基本信息编辑医院下拉列表863.15.5. 科室职称列表873.15.6. 城市列表883.15.7. 省份列表884. 附录894.1. 异常状态码定义891. 引言本文档用于描述CMS后台服务接口流程、规范，主要包括：网络传输协议、数据传输协议,参数及返回值说明等内容。2. 接口规范2.1. 协议接口基于HTTP协议，支持GET/POST请求，以JSON格式返回数据。2.2. 地址接口地址为(测试域名)：http:/cms.7lk.me/接口地址为(正式环境域名)：/2.3. 参数示例参数名类型必选备注param1StringY字符串类型参数param2IntegerY数字类型参数param3LongY数字类型param4JsonNJson对象类型参数（见说明）说明： abc:abc, def:def2.4. 返回值返回值的基本结构如下：code:,“msg”:”, data:,返回值结构描述属性含义取值code本次请求状态码0：表示成功；其他数字表示异常。msg状态码对应的信息状态码对应的提示信息。data业务相关数据JSON数组。不同接口返回的JSON数据对象3. 接口详情3.1. 医生相关接口3.1.1. 医生认证审核状态列表描述商务代表/医生，积分详情页面积分汇总信息地址/cms/doctor/authStatus参数参数名类型必须备注方法POST响应成功 code: 0, msg: 成功, data: id:0， name:待审核 , id:1， name:审核通过 返回状态提示信息保存值显示值保存值显示值失败code的值不为0的时候，请直接显示msg的值备注3.1.2. 医生搜索列表描述商务代表/医生，积分详情页面积分汇总信息地址/cms/doctor/pageList参数参数名类型必须备注keywordTypeIntegerN关键字类别(1:手机号码,2:医生姓名,3:上级姓名,4:业务归属人姓名,5:上级手机号)keywordStringN关键字doctorLabelIntegerN医生标签（3.6.5获取标签配置）provinceIdLongN省份id（3.6.2地区树）cityIdLongN城市id（3.6.2地区树）busiLargIdLongN业务大区id（3.6.4业务区域列表）busiProIdLongN业务省区id（3.6.4业务区域列表）busiCityIdLongN业务市区id（3.6.4业务区域列表）registStartStringN注册时间开始 (yyyy-MM-dd mm:HH:ss)registEndStringN注册时间结束 (yyyy-MM-dd mm:HH:ss)auditStatusIntegerN审核状态pageIntegerN页数numIntegerN每页记录数方法POST响应成功 code: 0, msg: 成功, data: pageNo: 1, pageSize: 10, orderBy: null, order: null, result: doctorId: 111, doctorName: 测试医生, phone: 10010001000, hospital: 北京第一人民医院, department: 神经内科, location: 北京市毛泽东纪念馆, inviteDoctorNum: 100, invitePatientNum: 100, attendNum: 100, zambiaNum: 100, pointCount: 10000, balance: 10000, registTime: 2015-12-04 16:57:08, supType: 0, supId: 100, supName: 上级测试医生/商务代表, supPhone: 10011111111, doctorLabel: 种子医生, businessArea: 华南大区-北京-北京, relationBusiId: 10, relationBusiName: 测试业务代表, auditStatus: 审核通过, isTest: 0, acountStatus:0, partnerName:步长 , totalCount: 2, first: 0, orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1 返回状态提示信息医生id医生姓名手机号医院科室所在地发展医生数量发展患者数被关注数好评数积分（总积分）总诊金注册时间上级类型(0:商代,1：医生)上级ID上级名称上级手机号医生标签业务归属地业务归属人id业务归属人（名称）审核状态是否测试(0:正式,1:测试)是否禁用(0:正常1:禁用)公司名称失败code的值不为0的时候，请直接显示msg的值备注3.1.3. 医生列表导出Excel描述商务代表/医生，积分详情页面积分汇总信息地址/cms/doctor/export参数参数名类型必须备注keywordTypeIntegerN关键字类别(1:手机号码,2:医生姓名,3:上级姓名,4:业务归属人姓名,5:上级手机号)keywordStringN关键字doctorLabelIntegerN医生标签（3.6.5获取标签配置）provinceIdLongN省份id（3.6.2地区树）cityIdLongN城市id（3.6.2地区树）busiLargIdLongN业务大区id（3.6.4业务区域列表）busiProIdLongN业务省区id（3.6.4业务区域列表）busiCityIdLongN业务市区id（3.6.4业务区域列表）registStartStringN注册时间开始 (yyyy-MM-dd mm:HH:ss)registEndStringN注册时间结束 (yyyy-MM-dd mm:HH:ss)auditStatusIntegerN审核状态方法POST响应成功生成的Excel流失败 code: 001, msg: 下载失败, data: code的值不为0的时候，请直接显示msg的值错误状态提示信息备注3.1.4. 医生基本信息编辑描述CMS后台-医生基本信息变更地址/cms/doctor/update参数参数名类型必须备注doctorIdLongY医生idgenderIntegerN性别(0,女；1,男)cityIdIntegerN地区IDhospitalIdIntegerN所在医院IDhospitalNameStringN自定义医院名称departmentIdIntegerN科室IDtitleIntegerN职称(0医师，1副主任医师，2主任医师，3主治医师，4主院医师)expertiseStringN擅长introductionStringN个人简介phoneFileStreamN个人头像emCardFileStreamN工作证vocateFileStreamN职业资格证consultN出诊时间各种信息json串（出诊时间修改界面，点保存，全量修改）weekIndex: 1,/星期（17）am: 0,pm: 1,night: 0,weekIndex: 1,am: 0,pm: 1,night: 0bayConsultN全部时间 json串如weekIndex: 1, 星期几work: 11:00-12:00;09:00-10:00,weekIndex: 2,work: 11:00-12:00;09:00-10:00operatorStringY操作人cmsUserIdStringYCMS登录用户ID方法GET/POST响应成功code: 0,msg: success,data: 结果码：0/修改成功；非0(1,2,3)/失败消息提示：success；(示例：修改失败/)失败code的值不为0的时候，请直接显示msg的值备注3.1.5. 医生认证审核接口新增描述医生认证审核接口地址/cms/doctor/audit参数参数名类型必须备注doctorIdLongY医生idauditTypeIntegerY标识操作类型（1：审核通过，2：审核不通过）auditOpinionIntegerN审核不通过备注operatorStringY操作人方法POST响应成功code: 0,msg: success,data: 结果码消息提示失败code的值不为0的时候，请直接显示msg的值备注3.1.6. 标识、取消标识医生描述标识测试医生地址/cms/doctor/signTest参数参数名类型必须备注doctorIdLongY医生IDsignTypeIntegerY标识测试类型（1：标识，2：取消标识）operatorStringY操作人方法GET/POST响应成功code: 0,msg: 成功,data: 返回状态提示信息失败code的值不为0的时候，请直接显示msg的值备注3.1.7. 禁用医生账户描述禁用医生账户地址/cms/doctor/disable参数参数名类型必须备注doctorIdLongY医生IDoperateTypeIntegerY禁用操作类型（1：禁用，2：取消禁用）operatorStringY操作人方法GET/POST响应成功code: 0,msg: 成功,data: 返回状态提示信息失败code的值不为0的时候，请直接显示msg的值备注3.1.8. 医生基本信息编辑能否保存描述医生基本信息编辑页面保存按钮能否保存地址/cms/doctor/ isSubAudit参数参数名类型必须备注doctorIdLongY医生id方法POST响应成功code: 0,msg: success,data: isSubAudit:0 结果码消息提示页面下方保存按钮是否可点击：0:不可以点击；1:可以点击失败code的值不为0的时候，请直接显示msg的值备注3.1.9. 医生用药配置保存描述医生用药配置保存地址/cms/medicationBox/saveMedicationBox参数参数名类型必须备注doctorIdLongY医生IDmedicationListStringN用药配置列表：json格式(空表示无)pid: 384,/ 商品IDname: 感冒清片 广州巨虹 0.22g*100片, / 药品名commonName: 感冒清片 / 通用名,pid: 13072,/ 商品IDname: 感冒清胶囊 新峰 0.5g*24s, / 药品名commonName: 感冒清胶囊 / 通用名方法GET/POST响应成功code: 0,msg: 成功,data: 返回状态提示信息失败code的值不为0的时候，请直接显示msg的值备注3.1.10. 修改上级接口描述医生修改上级操作地址/cms/invter/update参数参数名类型必须备注userIdLongY需要变更上级用户IDuserTypeIntegerY用户类型(0商务代表，1医生)parentIdLongY目标上级IDparentTypeIntegerY用户类型(0商务代表，1医生)方法GET/POST响应成功code: 0,msg: 成功,data: 返回状态提示信息失败code的值不为0的时候，请直接显示msg的值备注3.1.11. 上级变更记录列表描述医生上级变更记录列表地址/cms/invter/list参数参数名类型必须备注userIdLongY需要变更上级用户IDuserTypeIntegerY用户类型(0商务代表，1医生)方法POST响应T成功 code: 0, msg: 成功, data: pageNo: 1, pageSize: 10, orderBy: null, order: null, result: id: 1, createdAt: 2016-05-04 12:., changeType:1, orginInvterId: 123, orginInvterType: 1, orginInvterName: 张三, targetInvterId: 456, targetInvterType:1, targetInvterName: 李四 , totalCount: 2, first: 0, orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1 返回状态提示信息记录ID操作时间变更类型(0,变更；1,添加)原上级ID原上级类型(0,代表;1,医生)原上级名称现上级ID现上级类型(0,代表;1,医生)现上级名称失败code的值不为0的时候，请直接显示msg的值备注3.2. 商务代表相关接口3.2.1. 商务代表数量汇总信息描述商务代表数量汇总信息地址/cms/business/countInfo参数参数名类型必须备注方法POST响应成功 code: 0, msg: 成功, data: totalCount: 1000, previousAdd: 100 返回状态提示信息总数昨日新增失败code的值不为0的时候，请直接显示msg的值备注3.2.2. 商务代表搜索列表描述商务代表列表搜索地址/cms/business/pageList参数参数名类型必须备注keywordTypeIntegerN关键字类别(1:手机号码,2:商务代表姓名,3:上级姓名,4:上级手机号,5:合作方名称,6:公司名称)keywordStringN关键字busiLargIdLongN业务大区id（3.6.4业务区域列表）busiProIdLongN业务省区id（3.6.4业务区域列表）busiCityIdLongN业务市区id（3.6.4业务区域列表）registStartStringN注册时间开始 (yyyy-MM-dd mm:HH:ss)registEndStringN注册时间结束 (yyyy-MM-dd mm:HH:ss)busiTypeIntegerN商务代表类型（1:兼职代表，2:正式代表）pageIntegerN页数numIntegerN每页记录数方法POST响应成功 code: 0, msg: 成功, data: pageNo: 1, pageSize: 10, orderBy: null, order: null, result: id: 1, name: 商务代表1, phone: 12311111111, address: 地址1, doctorCount: 11, busiCount: 11, registTime: 2015-12-24 17:06:32, superior: 商务代表X, superiorId: 100, superiorPhone: applyingPoint: 1000, amountPoint: 2000, busiType: 兼职代表, acountStatus:0, partnerName:步长 , totalCount: 2, first: 0, orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1 返回状态提示信息ID姓名捆绑手机地区发展医生数量商务代表数量注册时间上级上级ID上级手机可提现积分总积分商务代表类型是否禁用(0:正常1:禁用)公司名称失败code的值不为0的时候，请直接显示msg的值备注3.2.3. 商务代表列表导出Excel描述商务代表列表导出excel地址/cms/business/export参数参数名类型必须备注keywordTypeIntegerN关键字类别(1:手机号码,2:商务代表姓名,3:上级姓名,4:上级手机号,5:合作方名称，6:公司名称)keywordStringN关键字busiLargIdLongN业务大区id（3.6.4业务区域列表）busiProIdLongN业务省区id（3.6.4业务区域列表）busiCityIdLongN业务市区id（3.6.4业务区域列表）registStartStringN注册时间开始 (yyyy-MM-dd mm:HH:ss)registEndStringN注册时间结束 (yyyy-MM-dd mm:HH:ss)busiTypeIntegerN商务代表类型（1:兼职代表，2:正式代表）方法POST响应成功生成的Excel流失败 code: 001, msg: 下载失败, data: code的值不为0的时候，请直接显示msg的值返回状态提示信息备注3.2.4. 商务代表个人基本信息编辑描述CMS后台-商务代表基本信息变更地址/cms/business/titleUpdate参数参数名类型必须备注businessIdLongY商务代表idtitleTypeIntegerN职务businessTypeIntegerN商务代表类型partnerStringN合作方companyStringN公司isQuitIntegerN是否离职：0,否；1,是quitTimeStringN离职日期，(isQuit非空的情况此项必填)partnerIdLongN公司IDcardIdNumStringN身份证号码operatorStringY操作人cmsUserIdStringYCMS登录用户ID方法GET/POST响应成功code: 0,msg: success,data: 结果码：0/修改成功；非0(1,2,3)/失败消息提示：success；(示例：修改失败/)失败code的值不为0的时候，请直接显示msg的值备注3.2.5. 商务代表禁用、启用描述商务代表禁用、启用接口地址/cms/business/upAccountStatus参数参数名类型必须备注businessIdLongY商务代表IDaccountStatusIntegerY账号状态(0,正常；1,禁用)operatorStringY操作人cmsUserIdStringYCMS登录用户ID方法GET/POST响应成功code: 0,msg: 成功,data: 返回状态提示信息失败code的值不为0的时候，请直接显示msg的值备注3.3. 患者相关接口3.3.1. 标识测试患者描述标识测试患者地址/cms/patient/signTest参数参数名类型必须备注patientIdLongY患者IDsignType IntegerY标识操作类型（0：撤销标识；1：标识测试）operatorStringY操作人方法GET/POST响应成功code: 0,msg: 成功,data: 返回状态提示信息失败code的值不为0的时候，请直接显示msg的值备注3.3.2. 患者诊金基本信息+患者诊金明细列表(含搜索)描述患者诊金基本信息+患者诊金明细列表(含搜索)地址/cms/ptWithdrawal/withdrawalList参数参数名类型必须备注patientIdY患者IDtransactionTypeY交易类型(1:问诊服务；2:获赠诊金)，默认1transactionStatusY交易状态(0:待支付；1:交易成功；2:交易失败)，默认1pageIntegerN页数numIntegerN每页记录数方法GET/POST响应成功 code: 0, msg: 成功, data: ptName: 张三, walletBalance: 800, waitPayAmount: 300, havePayAmount: 200, ptWdPage: pageNo: 1, pageSize: 10, orderBy: null, order: null, result: id: 1111, createdAt: 2015-12-24 14:06:49, settleTime: 2015-12-24 14:06:49, transactionType: 问诊服务, transactionInfo: 注册送诊金, totalAmount: 100, ticketsAmount: 100, settleAmount: 100, transactionStatus: 交易成功 , totalCount: 2, first: 0, orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1 患者姓名诊金钱包余额待支付诊金已支付诊金发生时间交易时间交易类型交易说明总金额诊金券金额现金金额交易状态失败code的值不为0的时候，请直接显示msg的值备注3.3.3. 患者基本信息编辑描述CMS后台-患者基本信息变更地址/cms/patient/update参数参数名类型必须备注patientIdLongY患者idcityIdIntegerN地区IDmaritalStatusIntegerN婚姻状况：0未婚；1已婚heightInteger身高genderinteger性别 0女1男weightinteger体重ageinteger年龄frequencyInteger饮酒情况(0：不喝酒；1：偶尔；2；经常；3：每天)drinkStartInteger饮酒开始年龄dayDrinkNumInteger日饮酒量isStopInteger是否已戒酒(0:未戒酒；1:已戒酒)stopAgeString戒酒年龄wineIdsString饮酒种类ID集wineStrString饮酒种类(患者自定义手动输入)medicationIdsString过敏药品ID集medicationStrString过敏药品(患者自定义手动输入)pasDiseaseIdsString既往病ID集pasDiseaseStrString既往病(患者自定义手动输入)inherDiseaseIdsString遗传病ID集inherDiseaseStrString遗传病(患者自定义手动输入)smokeStatusInteger吸烟状态，0：已戒烟；1：吸烟；2：不吸烟daySmokNumInteger每日吸烟量SmokeStartInteger开始吸烟年龄familyHistoryString家族病史：json格式(空表示无)number: 1,/ 成员0:父亲；1:母亲；2：兄弟姐妹；3:子女diseaseId: 1,2,3,4,5,6,others: 冠心病,number: 2,/ 成员0:父亲；1:母亲；2：兄弟姐妹；3:子女diseaseId: 7,8,9,10,others: XXXoperatorStringY操作人cmsUserIdStringYCMS登录用户ID方法GET/POST响应成功code: 0,msg: success,data: 结果码：0/修改成功；非0(1,2,3)/失败消息提示：success；(示例：修改失败/)失败code的值不为0的时候，请直接显示msg的值备注3.3.4. 患者禁用、启用描述患者禁用、启用接口