通用App接口定義文檔規(guī)范

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

2、;0002"String PARAM_ERROR_MSG = "參數(shù)錯誤或者參數(shù)不完整"String NO_PERMISSION = "UP01"String NO_PERMISSION_MSG = "無接口訪問權(quán)限"String UE01 = "UE01"String UE01_MSG = "未知接口異常"測試服務(wù)器調(diào)試路徑 7/ssm3登錄邏輯 附件如下：1.接口服務(wù)器驗證接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /lo

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

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

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

6、quot;data": "locationType": 1, /定位類型 GPS 0,北斗 1,基站 2. "coord": "latitude": 22.566235, "longitude": 113.90045 , "updateTime": 15452154,/更新時間"msg": “成功”,"code": “0000”4. 圍欄列表查詢接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/getWeiLan輸入

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

8、okentoken字符串2safeCircles圍欄列表字符串圍欄列表List<SafeCircle> JSON字符串SafeCirclemeter /半徑name /圍欄名稱gpsPointWeidu / 中心緯度gpsPointJingdu / 中心經(jīng)度輸出數(shù)據(jù)格式"msg": “成功”,"code": “0000”6. 歷史軌跡查詢接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/getHistoryLocation輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tokentoken字符串2時間date字符串

9、格式為2014-09-08需要返回的數(shù)據(jù): "count": 2, "data": "time": 1419241868124, "coord": "latitude": 22.576584, "longitude": 113.87609 , dingweiType:1/0北斗 1GPS 2基站 , "time": 1419241914042, "coord": "latitude": 22.575483, &quo

10、t;longitude": 113.873566 dingweiType:1 /.等等等 , "updatetime ": 1419241920307,"code": 0000msg:成功5親情號設(shè)置接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/setQinqinghao輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tokentoken字符串2親情號碼numbers字符串List<QH>的Json字符串Qinqinghao name:媽媽 phoneNum:138908872312需要返回的數(shù)據(jù):&

11、quot;code": 0000msg:成功6.獲取寶貝信息 數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/getStudentInfo輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1Imei號imeiLong需要返回的數(shù)據(jù): "data": "childBirthday": 123151351, "childGrade ": "", "childName": "", "childSex": 1 /1 男 2 女cod

12、e:0000msg:成功獲取親情號碼數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/getQinqinghao輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tokentoken字符串需要返回的數(shù)據(jù):count:2data:name:媽媽phoneNum:1390943233,name:爸爸phoneNum:1390943233code:0000msg:成功7.獲取上課隱身接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/getHide輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tokentoken字符串需要返回的數(shù)據(jù): "c

13、ount": 4, "data": "repeatCycleMode": "012", "timeEnd": "19:00", "timeStart": "8:00" ,“openState”:0 /表示是否啟用 字符串1表示啟用，0表示不啟用 /等等 ,"code": 0000msg:成功/*TimeEnd StringTimeStart StringRepeatCycleMode StringRepeatCycleMode

14、 :如果是沒有重復(fù)的話 -1,周一0,周二1,周三2,周四3,周五4,周六5,周日6,例如:重復(fù)周期為星期三 星期四的話 就為 23*/8.設(shè)置上課隱身接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/setHide輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tokentoken字符串2上課隱身對象ListhideTimes字符串List<HideTime> json字符串HideTime/* * 開始小時 */private int startHour;/* * 開始分鐘 */private int startMinute;/* * 結(jié)束小時 */

15、private int endHour;/* * 結(jié)束分鐘 */private int endMinute;/* * 模式，參考本類靜態(tài)變量 */private int mode; private String enabled; 表示是否啟用 字符串1表示啟用，0表示不啟用9.獲取鬧鐘接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/getClock輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tokentoken字符串需要返回的數(shù)據(jù): "count": 2, "data": "alarmsName":

16、"起床", "openState": true, "repeatCycleMode": "012", "time": "9:00" , "alarmsName": "午休", "openState": false, "repeatCycleMode": "234", "time": "10:00" ,"code": 2

17、00"msg": 成功10.設(shè)置鬧鐘接口 數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/setClock輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tokentoken字符串2鬧鐘身對象Listclocks字符串List< Clock > json字符串Clock "alarmsName": "起床", "openState": true, "repeatCycleMode": "012", "time": &q

18、uot;9:00"11.獲取一鍵撥號接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/getOneKey輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1Imei號imeiLong需要返回的數(shù)據(jù): "data":121212123232, /一鍵撥號注意下標對應(yīng)按鍵。"code": 0000"msg": 成功12.設(shè)置一鍵撥號接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/setOneKey輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tok

19、entoken字符串2一鍵撥號onekeys字符串4位的電話號碼數(shù)字 沒有的填0例如: 00筆 #1 為空 #2#3 為空 #4 1390908978913.設(shè)置休眠接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/setSleep輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1Imei號imeiLong2是否休眠isSleepBoolean是否休眠需要返回的數(shù)據(jù):"code": 0000"msg": 成功14.發(fā)起遠程監(jiān)聽接口數(shù)據(jù)接口定義備注1、調(diào)

20、用結(jié)果以json格式返回 2、接口地址: /card/getRemoteMonitoring輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tokentoken字符串2類型typeString1代表錄音2代表電話回撥3電話號碼phoneNumberString回撥的電話號碼需要返回的數(shù)據(jù):"code": 0000"msg": 成功15.遠程關(guān)機接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/remoteClose輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tokentoken字符串2phoneNumber手機號字符串需要返

21、回的數(shù)據(jù):"code": 0000"msg": 成功16.意見反饋接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /suggest輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tokentoken字符串可選2phoneNumber手機號字符串必填3content內(nèi)容字符串長度大于10個字(必填)4imgFile圖片二進制數(shù)據(jù)可選需要返回的數(shù)據(jù):"code": 0000"msg": 成功17.學(xué)生卡解綁接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/unBind輸入

22、字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tokentoken字符串必填 2adminNumber管理員手機號LONG必填3password管理員密碼字符串必填需要返回的數(shù)據(jù):"code": 0000"msg": 成功18.更換管理員號碼數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/changeAdminNumber輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1tokentoken字符串必填 2oldAdminNumber老管理員號碼LONG必填3newAdminNumber新管理員號碼LONG必填4password管理員密

23、碼字符串必填5deleteHistory是否刪除歷史軌跡BOOLEAN必填(true,false)6smsValidateCode短信驗證碼字符串必填需要返回的數(shù)據(jù):"code": 0000"msg": 成功19獲取休眠接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/getSleep輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1token需要返回的數(shù)據(jù):"code": 0000"msg": 成功“data”:”true” /或者 false20.查詢藍牙狀態(tài)接口數(shù)據(jù)接口定義備注1、調(diào)

24、用結(jié)果以json格式返回 2、接口地址: /card/queryBlueTooth輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1token需要返回的數(shù)據(jù):"code": 0000"msg": 成功“data”:”1” /1或者 0 1是開啟 0 是關(guān)閉21.設(shè)置藍牙接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/setBlueTooth輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1token2on開啟、 關(guān)閉BooleanTrue,false需要返回的數(shù)據(jù):"code": 200"msg&qu

25、ot;: 成功22.設(shè)置定位周期接口數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/setDingWeiPeriod輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1token2second秒數(shù)int需要返回的數(shù)據(jù):"code": 0000"msg": 成功23.獲取短信驗證碼數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/getVaildCode輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注2phoneNumber手機號碼Long1token需要返回的數(shù)據(jù):"code": 0000&

26、quot;msg": 成功24.設(shè)置音量數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/setVolume輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1token2naozhongVolume鬧鐘音量int3xianglingVolume響鈴音量int4tonghuaVolume通話音量int需要返回的數(shù)據(jù):"code": 0000"msg": 成功25.獲取音量數(shù)據(jù)接口定義備注1、調(diào)用結(jié)果以json格式返回 2、接口地址: /card/getVolume輸入字段定義序號字段名稱字段定義數(shù)據(jù)類型備注1token需要返回的數(shù)據(jù):"code": 0000"msg": 成功“data”:”7;7;7” ;/ 7;7;7 分別是鬧鐘，響鈴，通話的