通用App接口定义文档规范

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