通用App接口定義文檔規范_第1頁
通用App接口定義文檔規范_第2頁
通用App接口定義文檔規范_第3頁
通用App接口定義文檔規范_第4頁
通用App接口定義文檔規范_第5頁
已閱讀5頁,還剩14頁未讀 繼續免費閱讀

下載本文檔

版權說明:本文檔由用戶提供并上傳,收益歸屬內容提供方,若內容存在侵權,請進行舉報或認領

文檔簡介

1、 閱讀之前(必讀*):1. 所有接口返回數據格式為code:0000,msg:,data: 的形式 其中code 是響應碼 msg 是響應消息 默認正確響應無msg消息 只有錯誤才有錯誤消息 data 為數據段.Java段對應返回數據bean為如下形式。2. 響應碼表 對應 codeString SUCCESS = "0000"String SUCCESS_MSG = "成功"String ERROR = "0001"String ERROR_MSG = "失敗"String PARAM_ERROR = "

2、;0002"String PARAM_ERROR_MSG = "參數錯誤或者參數不完整"String NO_PERMISSION = "UP01"String NO_PERMISSION_MSG = "無接口訪問權限"String UE01 = "UE01"String UE01_MSG = "未知接口異常"測試服務器調試路徑 登錄邏輯 附件如下:1.接口服務器驗證接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /loginvalidate輸入字段定義序號字段名稱字

3、段定義數據類型備注1手機號phoneNumber字符串2tokentoken字符串需要返回的數據 "msg": “成功”,"code": “0000”data: token: role:1; /1 superadmin 2親情號 phoneNumber:139080090 name:王小二 sex:,/1 男 2 女 className:,birthday:, otherCards:imei:2313123 name:小明 1.1注銷接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /logout輸入字段定義序號字段名稱字段定義數據類型

4、備注1tokentoken字符串登錄得到的token字符串1.2修改密碼接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /setNewPassword輸入字段定義序號字段名稱字段定義數據類型備注1phoneNumber手機號字符串2老密碼oldPassword字符串3新密碼newPassword字符串4tokentoken字符串需要返回的數據 "msg": “成功”,"code": “0000”2.寶貝信息 設置接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /setStudentInfo輸入字段定義序號字段名稱字

5、段定義數據類型備注1tokentoken字符串3學生姓名name字符串4性別sex字符串5班級名稱className字符串6生日birthday字符串需要返回的數據 "msg": “成功”, "code": “0000”3. 學生卡主動定位接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/getCardLocation輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串需要返回的數據: "batteryValue": 100, /電量 "data": "l

6、ocationType": 1, /定位類型 GPS 0,北斗 1,基站 2. "coord": "latitude": 22.566235, "longitude": 113.90045 , "updateTime": 15452154,/更新時間"msg": “成功”,"code": “0000”4. 圍欄列表查詢接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/getWeiLan輸入字段定義序號字段名稱字段定義數據類型備注1tok

7、entoken字符串需要返回的數據: "count": 3, "data": “meter”:123123“name”:學校 /圍欄名稱“gpsPointWeidu”:23.123123 / 中心緯度“gpsPointJingdu”:132.23213123 / 中心經度 ,"code": 0000 “msg”:”成功”5. 設置圍欄接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/setSafeCircles輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串2safeCircles

8、圍欄列表字符串圍欄列表List<SafeCircle> JSON字符串SafeCirclemeter /半徑name /圍欄名稱gpsPointWeidu / 中心緯度gpsPointJingdu / 中心經度輸出數據格式"msg": “成功”,"code": “0000”6. 歷史軌跡查詢接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/getHistoryLocation輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串2時間date字符串格式為2014-09-08需要返回的數據: &q

9、uot;count": 2, "data": "t "coord": "latitude": 22.576584, "longitude": 113.87609 , dingweiType:1/0北斗 1GPS 2基站 , "t "coord": "latitude": 22.575483, "longitude": 113.873566 dingweiType:1 /.等等等 , "updatetime"

10、code": 0000msg:成功5親情號設置接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/setQinqinghao輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串2親情號碼numbers字符串List<QH>的Json字符串Qinqinghao name:媽媽 phoneNum:需要返回的數據:"code": 0000msg:成功6.獲取寶貝信息 數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/getStudentInfo輸入字段定義序號字段名稱字段定義數據類型備

11、注1Imei號imeiLong需要返回的數據: "data": "childBirthday": 123151351, "childGrade ": "", "childName": "", "childSex": 1 /1 男 2 女code:0000msg:成功獲取親情號碼數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/getQinqinghao輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串需要返回

12、的數據:count:2data:name:媽媽phoneNum:1390943233,name:爸爸phoneNum:1390943233code:0000msg:成功7.獲取上課隱身接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/getHide輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串需要返回的數據: "count": 4, "data": "repeatCycleMode": "012", "timeEnd": "19:

13、00", "timeStart": "8:00" ,“openState”:0 /表示是否啟用 字符串1表示啟用,0表示不啟用 /等等 ,"code": 0000msg:成功/*TimeEnd StringTimeStart StringRepeatCycleMode StringRepeatCycleMode :如果是沒有重復的話 -1,周一0,周二1,周三2,周四3,周五4,周六5,周日6,例如:重復周期為星期三 星期四的話 就為 23*/8.設置上課隱身接口數據接口定義備注1、調用結果以json格式返回 2、接口地址:

14、 /card/setHide輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串2上課隱身對象ListhideTimes字符串List<HideTime> json字符串HideTime/* * 開始小時 */private int startHour;/* * 開始分鐘 */private int startMinute;/* * 結束小時 */private int endHour;/* * 結束分鐘 */private int endMinute;/* * 模式,參考本類靜態變量 */private int mode; private String ena

15、bled; 表示是否啟用 字符串1表示啟用,0表示不啟用9.獲取鬧鐘接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/getClock輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串需要返回的數據: "count": 2, "data": "alarmsName": "起床", "openState": true, "repeatCycleMode": "012", "time":

16、"9:00" , "alarmsName": "午休", "openState": false, "repeatCycleMode": "234", "time": "10:00" ,"code": 200"msg": 成功10.設置鬧鐘接口 數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/setClock輸入字段定義序號字段名稱字段定義數據類型備注1tokentoke

17、n字符串2鬧鐘身對象Listclocks字符串List< Clock > json字符串Clock "alarmsName": "起床", "openState": true, "repeatCycleMode": "012", "time": "9:00"11.獲取一鍵撥號接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/getOneKey輸入字段定義序號字段名稱字段定義數據類型備注1Imei號imeiLong需

18、要返回的數據: "data": , /一鍵撥號注意下標對應按鍵。"code": 0000"msg": 成功12.設置一鍵撥號接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/setOneKey輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串2一鍵撥號onekeys字符串4位的電話號碼數字 沒有的填013.設置休眠接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/setSleep輸入字段定義序號字段名稱字段定義數據類型備注1Imei號imeiLong2是

19、否休眠isSleepBoolean是否休眠需要返回的數據:"code": 0000"msg": 成功14.發起遠程監聽接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/getRemoteMonitoring輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串2類型typeString1代表錄音2代表電話回撥3電話號碼phoneNumberString回撥的電話號碼需要返回的數據:"code": 0000"msg": 成功15.遠程關機接口數據接口定義備注1、調用結果

20、以json格式返回 2、接口地址: /card/remoteClose輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串2phoneNumber手機號字符串需要返回的數據:"code": 0000"msg": 成功16.意見反饋接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /suggest輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串可選2phoneNumber手機號字符串必填3content內容字符串長度大于10個字(必填)4imgFile圖片二進制數據可選需要返回的數據:"

21、;code": 0000"msg": 成功17.學生卡解綁接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/unBind輸入字段定義序號字段名稱字段定義數據類型備注1tokentoken字符串必填 2adminNumber管理員手機號LONG必填3password管理員密碼字符串必填需要返回的數據:"code": 0000"msg": 成功18.更換管理員號碼數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/changeAdminNumber輸入字段定義序號字段名稱字段

22、定義數據類型備注1tokentoken字符串必填 2oldAdminNumber老管理員號碼LONG必填3newAdminNumber新管理員號碼LONG必填4password管理員密碼字符串必填5deleteHistory是否刪除歷史軌跡BOOLEAN必填(true,false)6smsValidateCode短信驗證碼字符串必填需要返回的數據:"code": 0000"msg": 成功19獲取休眠接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/getSleep輸入字段定義序號字段名稱字段定義數據類型備注1token需要

23、返回的數據:"code": 0000"msg": 成功“data”:”true” /或者 false20.查詢藍牙狀態接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/queryBlueTooth輸入字段定義序號字段名稱字段定義數據類型備注1token需要返回的數據:"code": 0000"msg": 成功“data”:”1” /1或者 0 1是開啟 0 是關閉21.設置藍牙接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/setBlueTooth輸入字

24、段定義序號字段名稱字段定義數據類型備注1token2on開啟、 關閉BooleanTrue,false需要返回的數據:"code": 200"msg": 成功22.設置定位周期接口數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/setDingWeiPeriod輸入字段定義序號字段名稱字段定義數據類型備注1token2second秒數int需要返回的數據:"code": 0000"msg": 成功23.獲取短信驗證碼數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card

25、/getVaildCode輸入字段定義序號字段名稱字段定義數據類型備注2phoneNumber手機號碼Long1token需要返回的數據:"code": 0000"msg": 成功24.設置音量數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/setVolume輸入字段定義序號字段名稱字段定義數據類型備注1token2naozhongVolume鬧鐘音量int3xianglingVolume響鈴音量int4tonghuaVolume通話音量int需要返回的數據:"code": 0000"msg": 成功25.獲取音量數據接口定義備注1、調用結果以json格式返回 2、接口地址: /card/getVolume輸入字段定義序號字段名稱字段定義數據類型備注1token需要返回的數據:"code": 0000"msg": 成功“data”:”7;7;7” ;/ 7;7;7 分別是鬧鐘,響鈴,通話的音量級別,1-7級 return為nu

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯系上傳者。文件的所有權益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網頁內容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
  • 4. 未經權益所有人同意不得將文件中的內容挪作商業或盈利用途。
  • 5. 人人文庫網僅提供信息存儲空間,僅對用戶上傳內容的表現方式做保護處理,對用戶上傳分享的文檔內容本身不做任何修改或編輯,并不能對任何下載內容負責。
  • 6. 下載文件中如有侵權或不適當內容,請與我們聯系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

最新文檔

評論

0/150

提交評論