患者端APP-V2._第1页
患者端APP-V2._第2页
患者端APP-V2._第3页
患者端APP-V2._第4页
患者端APP-V2._第5页
已阅读5页,还剩35页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

1、.七乐康患者端接口文档版本号:V2.6.0文档编号:功能模块负责人相关接口备注患者APP咨询记录接口高亮亮3.2.9 患者咨询记录APP咨询记录接口由原IM服务接口切换为该接口,响应添加医生相关信息节点。请求参数不变。目录1.引言32.接口规范31.1.协议31.2.地址31.3.公共参数31.4.返回值33.接口详细说明43.1.首页&启动43.1.1.首页43.1.2.启动信息53.2.个人中心63.2.1.获取个人中心信息(侧边栏基本信息)63.2.2.余额详情73.2.3.积分列表73.2.4.优惠券列表83.2.5.意见反馈83.2.6.push消息推送93.2.7.推荐列表

2、93.2.8.获取患者是否初复诊113.3.视频预约113.3.1.提交视频预约113.3.2.预约成功123.3.3.我的预约133.3.4.预约详情153.3.5.取消预约163.4.注册登录173.4.1.获取appID173.4.2.微信登录183.4.3.获取验证码183.4.4.绑定手机号193.4.5.是否显示登录输入框203.5.找医生203.5.1.预约医生(视频预约)203.5.2.查找医生223.5.3.找医生-加载医生一周可预约时间234.关于异常状态码定义的建议251. 引言本文档用于描述微药店服务接口规范(不涉及用户购买流程),主要包括:网络传输协议、数据传输协议,

3、参数及返回值说明等内容。2. 接口规范1.1. 协议接口基于HTTP协议,支持GET/POST请求,以JSON格式返回数据。1.2. 地址接口地址为(开发):http:/ap.7lk.me接口地址为(正式):1.3. 公共参数参数名参数含义必选取值_p平台(预留区分手机、平板)Y0:android_手机1:ios_手机2:PC平台_o应用来源Y0:患者App 1:医生App2:患者微信3:互联网医院(PC)_n是否原生Y0:非原生(H5)1:原生_v版本号Y格式:x.x.x 例如:1.0.0_nv版本号(非原生H5)N格式:x.x.x 例如:1.0.0_m设备型号N例如:iphone5S_cJ

4、SONP的回调函数名NAjax调用使用,原生页面不传说明:如上参数为公共参数,请在Http Header中传递1.4. 返回值返回值的基本结构如下:"code":"", "msg":"", "data":,返回值结构描述属性含义取值code本次请求状态码0:表示成功;其他数字表示异常。msg状态码对应的信息状态码对应的提示信息。data业务相关数据JSON数组。不同接口返回的JSON数据对象3. 接口详细说明3.1. 首页&启动3.1.1. 首页描述首页地址/index参数参数名类型必须

5、备注patientId字符Y医生ID号token字符Y校验登陆方法GET/POST响应成功"code": 0,"msg": "成功","data": "infos": "name":"黄安","title":"医师","backgroundImg": "http:/yun.7lk.me/dri/photo/8466/1467192946773.png", "depar

6、tmentName": "眼科","fuzzyImg": "http:/yun.7lk.me/dri/photo/8466/1467192946773.png" ,"prsonal": 0,"firstDoctorId": 166 姓名级别头像地址科室名称模糊图片是否有私有医生(0:无,1:有)第一个绑定的医生Id失败code的值不为0的时候备注3.1.2. 启动信息描述启动信息地址/initData参数参数名类型必须备注方法GET/POST响应成功"code":

7、0,"msg": "成功","data": "limitValue": "revacation": "max": 0,"min": 10 ,"customerServPhone": "quot;,"serverTime": "09:00-18:00","cancelDetailList": "reason": "

8、我想改约其他时间。","code": 1026 ,"service": "type": 4,"name": "视频预约" 限制值信息预约描述限制客服电话客服服务时间取消预约描述信息取消信息取消码服务类型服务名称失败code的值不为0的时候备注3.2. 个人中心3.2.1. 获取个人中心信息(侧边栏基本信息)描述患者个人基本资料信息地址/patient/simpleInfo参数参数名类型必须备注patientId数字Y患者idtoken字符串Y加密串方法GET/POST响应成功"

9、;code": 0,"msg": "success","data": "name": "莉莉","photo": ""age": 20,"gender": "女","phone":123245647675,"balance":100,"pointNum":100010,"couponNum":1000 返回状态提示信息

10、姓名头像年龄性别手机号余额积分优惠券失败code的值不为0的时候,请直接显示msg的值备注3.2.2. 余额详情3.2.3. 积分列表描述个人中心查看积分历史地址/patient/balance参数参数名类型必须备注patientId数字Y患者idpage数字Y页数num数字Y每页条数(默认10)token字符串Y密钥方法POST响应成功"code": 0,"msg": "成功","data": "pageNo": 1,"pageSize": 10,"orderBy

11、": null,"order": null,"result": "totalBalance": 200,"date": "2015-12-12 11:11:11","name": "购药积分","num": 100 ,"totalCount": 2,"first": 0,"orderBySetted": false,"totalPages": 1,

12、"hasNext": false,"nextPage": 1,"hasPre": false,"prePage": 1 返回状态提示信息总积分积分时间积分名称积分数量记录总数失败code的值不为0的时候,请直接显示msg的值备注3.2.4. 优惠券列表参见b2c接口文档3.2.5. 意见反馈描述记录用户意见地址/patient/coupon参数参数名类型必须备注patientId数字Y患者idunionKey字符串N密钥(微信端必传)token字符串NAPP端必传suggestion字符串Y意见内容phone数字N

13、手机号方法POST响应成功"code": ,"msg": "success","data": 返回状态提示信息失败code的值不为0的时候,请直接显示msg的值备注3.2.6. push消息推送描述push消息发送地址/push/send参数参数名类型必须备注patientIdLongY患者idmessageStringY消息内容typeIntegerY消息类型(待定)方法POST响应成功"code": ,"msg": "success","da

14、ta": 返回状态提示信息失败code的值不为0的时候,请直接显示msg的值备注3.2.7. 推荐列表描述推荐列表地址/patient/doctor/recommend参数参数名类型必须备注patientId数字Y患者iddoctorId数字Y医生IDpage数字Y页数num数字Y每页条数(默认10)token字符串Y密钥方法POST响应成功"code": 0,"msg": "成功","data": "pageNo": 1,"pageSize": 10,"

15、orderBy": null,"order": null,"result": "id": 1,"doctorName": "杜松","createdAt": "2016-07-21 14:44:21","detail": "id": 1,"name": "三黄片","commonName": "这是啥","quanti

16、ty": 100,"usages": "一天一顿","bakup": "备注" ,"totalCount": 2,"first": 0,"orderBySetted": false,"totalPages": 1,"hasNext": false,"nextPage": 1,"hasPre": false,"prePage": 1 返回状态提示信息

17、推荐ID医生名称推荐时间推荐商品列表推荐商品详情ID商品名通用名商品数量用法用量备注失败code的值不为0的时候,请直接显示msg的值备注3.2.8. 获取患者是否初复诊描述推荐列表地址/patient/doctor/firstisit参数参数名类型必须备注patientId数字Y患者iddoctorId数字Y医生IDtoken字符串Y密钥方法POST响应成功"code": 0,"msg": "成功","data": "firstisit": 1 返回状态提示信息初诊复诊 0 初诊 1 复诊失败

18、code的值不为0的时候,请直接显示msg的值备注3.2.9. 咨询记录患者APP咨询记录接口,调整接口调用。返回数据添加医生相关数据返回描述患者咨询记录地址/patient/consultList参数参数名类型必须备注tokenStringYApp端tokenpatientIdLongY患者IddoctorIdLongN医生Id(为空时查询所有会话;不为空则查询当前医生会话)statusIntY1:未完成的会话;2全部的会话pageNoIntY页码 默认1pageSizeIntY每页记录数 默认20orderByStringN排序条件 0:升序 1:降序 默认升序方法POST响应成功

19、0;   "code":0,    "msg":"成功",    "data":                    "result":    &#

20、160;                               "name":"测试医生名称",            &#

21、160;       "headUrl":"xxx.jpg",                    "department":"XXX科室",         

22、;           "hospital":"xxx医院",                    "status":1,         

23、;           "sessionId":"12_12_123123",                    "fromId":1,       

24、60;            "toId":2,                    "beginTime":1434940653737,        &#

25、160;           "endTime":1434940653737,                    "relation":1,         

26、;           "payType":1,                    "payStatus":1,           &

27、#160;        "price":30,                    "containVideo":1,             &

28、#160;      "containRecom":1,                    "viewMsg":               &#

29、160;        "type":2,                        "content":"adfasdfasdf"       

30、                                         ,         

31、;   "pageNo":1,            "pageSize":1,            "totalCount":18,           &

32、#160;"totalPages":2            医生名称头像科室医院认证状态会话ID发送者接收者开始时间结束时间(结束时间为空则未结束)发起人:1医生,0患者是否收费:0免费,1付费会话状态:-1咨询中0:未支付1:已支付 会话价格包含视频咨询:0否,1是包含推荐购药:0否,1:是显示消息内容消息类型(见备注)消息内容(根据类型区分)失败消息类型:1 :文本消息;2 :图片消息;4 :音频消息;8 :视频消息;16:药方消息;32:链接消息;

33、64:购药咨询; 128:在线视频消息;备注3.3. 视频预约3.3.1. 提交视频预约描述提交视频预约地址/patient/reserve参数参数名类型必须备注patientId数字Y患者标识deviceInfo字符Y手机设备号(2rffsdfS2r2333)doctorId数字Y医生ID号startAt数字Y预约时间(毫秒)gender数字Y性别(0:女,1:男)content字符Y咨询内容age数字Y年龄files文件流N上传图片(文件列表)token字符Y校验登陆方法GET/POST响应成功"code": 0,"msg": "成功&qu

34、ot;,"data": "orderSn": "V00132016072200001" 请求状态提示信息订单号失败code的值不为0的时候备注3.3.2. 预约成功描述预约成功地址/patient/reservationInfo参数参数名类型必须备注patientId数字Y患者标识orderSn字符Y订单号token字符Y校验登陆方法GET/POST响应"code": 0,"msg": "成功","data": "orderSn": &

35、quot;12121333232323","status": 1,"startAt": "2016-6-15 12:30-13:00","remindInfo": "一小时后","name": "dd","headUrl": "/dd/wd/gf.jpg","title":"医师", ,"hospitalName": "广东省人民医院&q

36、uot;,"departmentName": "眼科","authStatus": 1"doctorId": 11221 订单号状态(1:待付款,2:待咨询,3:已取消,4:已结束)预约时间预约提醒医生姓名头像级别医院名称科室名称医生认证状态(0:未认证,1:已认证)医生ID号失败code的值不为0的时候备注3.3.3. 我的预约描述我的预约地址/patient/reservationList参数参数名类型必须备注patientId数字Y患者标识status数字N状态(1:待付款,2:待咨询,3:已取消,4:已结束

37、)page数字N页码,默认1num数字N每页数量,默认10token字符Y校验登陆方法GET/POST响应"code": 0,"msg": "成功","data": "pageNo": 1,"pageSize": 1,"orderBy": null,"order": null,"result": "reservationId": 14,"orderSn": "V001

38、22016072500003","status": 1,"startAt": "37191-01-21 19:20-19:50","period": 0,"charge": 0,"name": "王腾飞","headUrl": "http:/yun.7lk.me/dri/photo/8644/1468287184583.jpg","content": "222321313132

39、32423432","detailType": 1,"authStatus": 1,"detail":"超过15分钟未付款自动取消" ,"doctorId": 11221,"payStatus": 0,"cancelStatus": 0 ,"totalCount": 12,"first": 0,"prePage": 1,"nextPage": 2,"hasP

40、re": false,"hasNext": true,"totalPages": 12,"orderBySetted": false id号订单号状态(1:待付款,2:待咨询,3:已取消,4:已结束)预约时间预约时长(毫秒)预约费用(分)医生姓名头像症状描述描述类型(1:等待付款,2:等待医生发起视频咨询,3:您取消了本次预约,4:医生取消了本次预约,5:您超时未完成支付,6:医生取消了本次预约(医生超时未发起),7:患者取消了本次预约(患者超时未接受),8:已结束)医生认证状态(0:未认证,1:已认证)详情医生ID是否可支

41、付(0:否,1:是)是否可取消(0:否,1:是)失败code的值不为0的时候备注3.3.4. 预约详情描述预约详情地址/patient/reservationInfo参数参数名类型必须备注patientId数字Y患者id号orderSn字符Y订单号token字符Y校验登陆方法GET/POST响应"code": 0,"msg": "成功","data": "reservationId": 14,"orderSn": "V00122016072500003",

42、"status": 1,"startAt": "37191-01-21 19:20-19:50","period": 0,"charge": 0,"name": "王腾飞","headUrl": "http:/yun.7lk.me/dri/photo/8644/1468287184583.jpg","title": "住院医师","hospitalName"

43、: "北京协和医院","departmentName": "移动科室","remindInfo": "15时38分21秒","content": "22232131313232423432","fileUrls": ,"gender": 1,"age": 22,"detailType": 1,"detail":"超过15分钟未付款自动取消"

44、; ,"authStatus": 1,"doctorId": 11221"payStatus": 0,"cancelStatus": 0, id号订单号状态(1:待付款,2:待咨询,3:已取消,4:已结束)预约时间预约时长(毫秒)预约费用(分)医生姓名头像级别医院名称科室名称预约提醒症状描述文件列表年龄性别(0:男,1:女)描述类型(1:等待付款,2:等待医生发起视频咨询,3:您取消了本次预约,4:医生取消了本次预约,5:您超时未完成支付,6:医生取消了本次预约(医生超时未发起),7:患者取消了本次预约(患者超时未

45、接受),8:已结束)详情医生认证状态(0:未认证,1:已认证)医生id是否可支付(0:否,1:是)是否可取消(0:否,1:是)失败code的值不为0的时候备注3.3.5. 取消预约描述取消预约地址/patient/cancelReservation参数参数名类型必须备注patientId数字Y患者标识reservationId数字Y预约id号detail字符Y取消描述detailCode数字Y取消码token字符Y校验登陆方法GET/POST响应成功"code": 0,"msg": "成功","data": 失败c

46、ode的值不为0的时候备注备注3.4. 注册登录3.4.1. 获取appID描述获取微信登录应用appId地址/wxLogin/getAppId参数参数名类型必须备注方法GET/POST响应成功"code": 0,"msg": "成功","data": "appId": "215315" 失败code的值不为0的时候备注获取微信app授权id。3.4.2. 微信登录描述微信登录授权请求地址/wxLogin/login参数参数名类型必须备注accessCodeStringY微信

47、返回授权码方法GET/POST响应成功"code": 0,"msg": "成功","data": "patientId": "215315","token": "215315","qlkId ":"22232 ","bindPhone":"1 ", 患者id患者token七乐康id是否绑定手机号:1绑定,0未绑定失败code的值不为0的时候备注1. 该接口返

48、回code码为40036时,表示用户获取的授权码不正常,或者已经过期,需要客户端进行重新让用户进行授权,使用新的授权码进行登陆。2. 该接口返回code码为40037时,表示获取用户的微信信息失败,需要客户端进行重新让用户进行授权,使用新的授权码进行登陆。3. 当登陆成功返回用户未绑定手机号时,需要客户端调用3.4.3进行获取验证码。绑定手机号使用的actionType=0,即资料完善,增加手机号。3.4.3. 获取验证码描述用户在注册或忘记密码时需要发送手机验证码进行认证,调此接口进行验证码下发(注:发送失败情况可能存在示例情况:今日发送量已达上限/运营商业务繁忙等)。地址/sms/send

49、参数参数名类型必须备注phoneNumY用户输入手机号码actionTypeY0:资料完善,新增手机号;1:修改手机号方法GET/POST响应成功"code": 0,"msg": "成功","data": 失败code的值不为0的时候备注3.4.4. 绑定手机号描述微信登录绑定手机号地址/patient/bindPhone参数参数名类型必须备注patientIdStringY患者idtokenStringY患者tokenphoneNumStringY手机号verifyCodeStringY验证码方法GET/POST

50、响应成功"code": 0,"msg": "成功","data": "patientId": "215315","token": "","qlkId ":"22232 ", 患者id访问key七乐康id失败code的值不为0的时候备注3.4.5. 是否显示登录输入框描述Iphone客户端是否显示登录框(此接口仅用于验证iphone客户端)地址/inputBox/displayOrNotHeader

51、 参数参数名类型必须备注_pStringY客户端平台_vStringY客户端版本号_oStringY来源_nStringY是否原生方法GET/POST响应成功"code": 0,"msg": "成功","data": "result": 0 result:0 显示输入框1 不显示输入框失败code的值不为0的时候,请直接显示msg的值备注1.校验iphone平台版本,确认是否显示登录输入框,微信/android平台无需检查2.当服务端返回result=0时,客户端显示登录输入框3.当服务端返回r

52、esult=1时,客户端不显示登录输入框4.软件版本格式:x.x.x 例如:1.0.05.版本对比方法:获取iphone客户端软件版本,从服务器端redis中获取软件版本,客户端软件版本与服务器端软件版本对比,确认iphone客户端软件是否显示登录输入框.3.5. 找医生3.5.1. 预约医生(视频预约)描述可以视频预约的医生地址/search/reserveList参数参数名类型必须备注patientIdLongY用户id(患者id)tokenStringY加密字符串reserveTimeStringY预约时间cityIdIntegerN城市市iddepartIdIntegerN二级科室Id

53、servingTypeIntegerN服务类型 0-全部 1-图文咨询 2-语音(预留)4-视频pageIntegerN页数,默认1numIntegerN每页条数,默认10方法GET/POST响应成功 "code": 0, "msg": "成功", "data": "defaultReq": "cityId": 79, "departId": 1 , "doctorList": "pageNo": 1, "

54、pageSize": 10, "orderBy": null, "order": null, "result": "doctorId": 50, "doctorName": "Dr.", "headerImageUrl": "http:/xx.jpg", "title": "主任医师", "hospital": "南方医院", "expe

55、rtise": "确认修改信息了啊", "payMessage": "99元/次/15分钟", "canReserve": 0 , , "totalCount": 0, "first": 0, "hasNext": false, "prePage": 1, "nextPage": 1, "hasPre": false, "orderBySetted": false,

56、"totalPages": 0 结果码:0成功;非0失败消息提示:success默认条件二级城市id二级科室id当前页数每页展示订单数医生ID医生姓名医生头像职称医院擅长付费说明能否预约视频0-能1-不能结果总数总页数是否有下一页下一页页码是否有上一页上一页页码失败code的值不为0的时候,请直接显示msg的值备注3.5.2. 查找医生描述患者端根据名字搜索医生地址/search/list参数参数名类型必须备注patientIdLongY用户id(患者id)tokenStringY用户keykeywordStringN搜索关键字(医生姓名)cityIdIntegerN城市市

57、id(默认广州市id)departIdIntegerN二级科室Id如果没选二级科室传一级科室idservingTypeIntegerN服务类型 0-全部 1-图文咨询 2-语音(预留)4-视频pageIntegerN页数,默认1numIntegerN每页条数,默认10方法GET/POST响应成功 "code": 0, "msg": "成功", "data": "defaultReq": "cityId": 6, "departId": 1, , "doctorList": "page

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论