《通用app接口定义文档规范》由会员分享，可在线阅读，更多相关《通用app接口定义文档规范（19页珍藏版）》请在金锄头文库上搜索。
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 = 0002;String PARAM_ERROR_MSG = 参数错误或者参数不完整;String
2、NO_PERMISSION = UP01;String NO_PERMISSION_MSG = 无接口访问权限;String UE01 = UE01;String UE01_MSG = 未知接口异常;测试服务器调试路径 http:/115.159.28.17/ssm3登录逻辑 附件如下：1.接口服务器验证接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /loginvalidate输入字段定义序号字段名称字段定义数据类型备注1手机号phoneNumber字符串2tokentoken字符串需要返回的数据 msg: “成功”,code: “0000”data: token: ro
3、le:1; /1 superadmin 2亲情号 phoneNumber:139080090 name:王小二 sex:,/1 男 2 女 className:,birthday:, otherCards:imei:2313123 name:小明 1.1注销接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /logout输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串登录得到的token字符串1.2修改密码接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /setNewPassword输入字段定义序号字段名称字段定义数据类型备注1ph
4、oneNumber手机号字符串2老密码oldPassword字符串3新密码newPassword字符串4tokentoken字符串需要返回的数据 msg: “成功”,code: “0000”2.宝贝信息 设置接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /setStudentInfo输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串3学生姓名name字符串4性别sex字符串5班级名称className字符串6生日birthday字符串需要返回的数据 msg: “成功”, code: “0000”3. 学生卡主动定位接口数据接口定义备注1、调用结果以j
5、son格式返回 2、接口地址: /card/getCardLocation输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据: batteryValue: 100, /电量 data: locationType: 1, /定位类型 GPS 0,北斗 1,基站 2. coord: latitude: 22.566235, longitude: 113.90045 , updateTime: 15452154,/更新时间msg: “成功”,code: “0000”4. 围栏列表查询接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/g
6、etWeiLan输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据: count: 3, data: “meter”:123123“name”:学校 /围栏名称“gpsPointWeidu”:23.123123 / 中心纬度“gpsPointJingdu”:132.23213123 / 中心经度 ,code: 0000 “msg”:”成功”5. 设置围栏接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/setSafeCircles输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2safeCircles围栏
7、列表字符串围栏列表List JSON字符串SafeCirclemeter /半径name /围栏名称gpsPointWeidu / 中心纬度gpsPointJingdu / 中心经度输出数据格式msg: “成功”,code: “0000”6. 历史轨迹查询接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/getHistoryLocation输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2时间date字符串格式为2014-09-08需要返回的数据: count: 2, data: time: 1419241868124, coord: la
8、titude: 22.576584, longitude: 113.87609 , dingweiType:1/0北斗 1GPS 2基站 , time: 1419241914042, coord: latitude: 22.575483, longitude: 113.873566 dingweiType:1 /.等等等 , updatetime : 1419241920307,code: 0000msg:成功5亲情号设置接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/setQinqinghao输入字段定义序号字段名称字段定义数据类型备注1tokentoken字
9、符串2亲情号码numbers字符串List的Json字符串Qinqinghao name:妈妈 phoneNum:138908872312需要返回的数据:code: 0000msg:成功6.获取宝贝信息 数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/getStudentInfo输入字段定义序号字段名称字段定义数据类型备注1Imei号imeiLong需要返回的数据: data: childBirthday: 123151351, childGrade : , childName: , childSex: 1 /1 男 2 女code:0000msg:成功获取亲情号码
10、数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/getQinqinghao输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据:count:2data:name:妈妈phoneNum:1390943233,name:爸爸phoneNum:1390943233code:0000msg:成功7.获取上课隐身接口数据接口定义备注1、调用结果以json格式返回 2、接口地址: /card/getHide输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据: count: 4, data: repeatCyc
11、leMode: 012, timeEnd: 19: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、接口地址: /card/setHide输入字段定义序号字段名称字段定义数据类型
