通用App接口定义文档规范.docx

1、通用App接口定义文档规范 阅读之前（必读*）：1. 所有接口返回数据格式为code:0000,msg:,data: 的形式 其中code 是响应码 msg 是响应消息 默认正确响应无msg消息 只有错误才有错误消息 data 为数据段.Java段对应返回数据bean为如下形式。2. 响应码表 对应 code String SUCCESS = 0000; String SUCCESS_MSG = 成功; String ERROR = 0001; String ERROR_MSG = 失败; String PARAM_ERROR = 0002; String PARAM_ERROR_MSG =

2、参数错误或者参数不完整; String NO_PERMISSION = UP01; String NO_PERMISSION_MSG = 无接口访问权限; String UE01 = UE01; String UE01_MSG = 未知接口异常; 测试服务器调试路径 登录逻辑 附件如下：1.接口服务器验证接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /loginvalidate输入字段定义序号字段名称字段定义数据类型备注1手机号phoneNumber字符串2tokentoken字符串需要返回的数据 msg: “成功”,code: “0000”data: token: ro

3、le:1; 贝信息 设置接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /setStudentInfo输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串3学生姓名name字符串4性别sex字符串5班级名称className字符串6生日birthday字符串需要返回的数据 msg: “成功”, code: “0000”3. 学生卡主动定位接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/getCardLocation输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据: batteryVal

4、ue: 100, coord: latitude: , longitude: ,4. updateTime: ,.等等等 , updatetime : ,code: 0000msg:成功5亲情号设置接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/setQinqinghao输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2亲情号码numbers字符串List的Json字符串Qinqinghao name:妈妈 phoneNum:需要返回的数据:code: 0000msg:成功6.获取宝贝信息 数据接口定义备注1、调用结果以json格式返回

5、2、接口地址: /card/getStudentInfo输入字段定义序号字段名称字段定义数据类型备注1Imei号imeiLong需要返回的数据: data: childBirthday: 1, childGrade : , childName: , childSex: 1 取上课隐身接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/getHide输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据: count: 4, data: repeatCycleMode: 012, timeEnd: 19:00, timeStart: 8

6、:00 ,“openState”:0 置上课隐身接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/setHide输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2上课隐身对象ListhideTimes字符串List json字符串HideTime/* * 开始小时 */ private int startHour; /* * 开始分钟 */ private int startMinute; /* * 结束小时 */ private int endHour; /* * 结束分钟 */ private int endMinute; /* * 模

7、式，参考本类静态变量 */ private int mode; private String enabled; 表示是否启用 字符串1表示启用，0表示不启用9.获取闹钟接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/getClock输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据: count: 2, data: alarmsName: 起床, openState: true, repeatCycleMode: 012, time: 9:00 , alarmsName: 午休, openState: false, repea

8、tCycleMode: 234, time: 10:00 ,code: 200msg: 成功10.设置闹钟接口 数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/setClock输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2闹钟身对象Listclocks字符串List json字符串Clock alarmsName: 起床, openState: true, repeatCycleMode: 012, time: 9:0011.获取一键拨号接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/getOneKey输入

9、字段定义序号字段名称字段定义数据类型备注1Imei号imeiLong需要返回的数据: data: , 置一键拨号接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/setOneKey输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2一键拨号onekeys字符串4位的电话号码数字 没有的填0例如: 0,0,代笔 #1 为空 #2 #3 为空 #4 13.设置休眠接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/setSleep输入字段定义序号字段名称字段定义数据类型备注1Imei号imeiLong2是否休眠isSl

10、eepBoolean是否休眠需要返回的数据:code: 0000msg: 成功14.发起远程监听接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/getRemoteMonitoring输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2类型typeString1代表录音2代表电话回拨3电话号码phoneNumberString回拨的电话号码需要返回的数据:code: 0000msg: 成功15.远程关机接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/remoteClose输入字段定义序号字段名称字段定义数据类型

11、备注1tokentoken字符串2phoneNumber手机号字符串需要返回的数据:code: 0000msg: 成功16.意见反馈接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /suggest输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串可选2phoneNumber手机号字符串必填3content内容字符串长度大于10个字(必填)4imgFile图片二进制数据可选需要返回的数据:code: 0000msg: 成功17.学生卡解绑接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/unBind输入字段定义序号字段名称字

12、段定义数据类型备注1tokentoken字符串必填 2adminNumber管理员手机号LONG必填3password管理员密码字符串必填需要返回的数据:code: 0000msg: 成功18.更换管理员号码数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/changeAdminNumber输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串必填 2oldAdminNumber老管理员号码LONG必填3newAdminNumber新管理员号码LONG必填4password管理员密码字符串必填5deleteHistory是否删除历史轨迹BOOLEAN

13、必填(true,false)6smsValidateCode短信验证码字符串必填需要返回的数据:code: 0000msg: 成功19获取休眠接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/getSleep输入字段定义序号字段名称字段定义数据类型备注1token需要返回的数据:code: 0000msg: 成功“data”:”true” 询蓝牙状态接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/queryBlueTooth输入字段定义序号字段名称字段定义数据类型备注1token需要返回的数据:code: 0000msg: 成功“d

14、ata”:”1” 置蓝牙接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/setBlueTooth输入字段定义序号字段名称字段定义数据类型备注1token2on开启、 关闭BooleanTrue,false需要返回的数据:code: 200msg: 成功22.设置定位周期接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/setDingWeiPeriod输入字段定义序号字段名称字段定义数据类型备注1token2second秒数int需要返回的数据:code: 0000msg: 成功23.获取短信验证码数据接口定义备注1、调用结果以jso

15、n格式返回 2、接口地址: /card/getVaildCode输入字段定义序号字段名称字段定义数据类型备注2phoneNumber手机号码Long1token需要返回的数据:code: 0000msg: 成功24.设置音量数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/setVolume输入字段定义序号字段名称字段定义数据类型备注1token2naozhongVolume闹钟音量int3xianglingVolume响铃音量int4tonghuaVolume通话音量int需要返回的数据:code: 0000msg: 成功25.获取音量数据接口定义备注1、调用结果以

16、json格式返回 2、接口地址: /card/getVolume输入字段定义序号字段名称字段定义数据类型备注1token需要返回的数据:code: 0000msg: 成功“data”:”7;7;7” ;置自动开关机数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/setPowerOnOff输入字段定义序号字段名称字段定义数据类型备注1token2powerOnOffpowerOnOffPowerOnOff对象PowerOnOffprivate long imei; private int onHour; private int onMinute; /* * 模式,以7

17、个0或者1表示，单次不重复是0000000 , 每星期二星期三重复是0110000 */ private String onMode; private boolean onEnabled; private int offHour; private int offMinute; private String offMode; private boolean offEnabled;取自动开关机数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/getAutoPowerOnOff输入字段定义序号字段名称字段定义数据类型备注1token需要返回的数据:code: 0000msg: 成功“data”: imei :, onHour:1 询话费数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/queryLeftMoney输入字段定义序号字段名称字段定义数据类型备注1token需要返回的数据:code: 0000msg: 成功