患者端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

提交評論