1 / 22
文档名称:

通用app接口定义文档规范.doc

格式:doc   大小:249KB   页数:22页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

通用app接口定义文档规范.doc

上传人:2028423509 2021/5/8 文件大小:249 KB

下载得到文件列表

通用app接口定义文档规范.doc

相关文档

文档介绍

文档介绍:阅读之前(必读*):
所有接口返回数据格式为
{
code:’0000’,
msg:’’,
data:{}
}
的形式 其中code 是响应码 msg 是响应消息 默认正确响应无msg消息 只有错误才有错误消息 data 为数据段.
Java段对应返回数据bean为如下形式。
响应码表 对应 code
String SUCCESS = "0000";
String SUCCESS_MSG = "成功";
StringERROR = "0001";
String ERROR_MSG = "失败";
String PARAM_ERROR = "0002";
String PARAM_ERROR_MSG = "参数错误或者参数不完整";
String NO_PERMISSION = "UP01";
String NO_PERMISSION_MSG = "无接口访问权限";
String UE01 = "UE01";
String UE01_MSG = "未知接口异常";
测试服务器调试路径

登录逻辑 附件如下:

数据接口定义
备注
1、调用结果以json格式返回
2、接口地址: /loginvalidate
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
手机号
phoneNumber
字符串
2
token
token
字符串
需要返回的数据
{
"msg": “成功”,
"code": “0000”
data:{
token:’’
role:’1’; //1 superadmin 2亲情号
phoneNumber:’139080090’
name:’王小二’
sex:’’,//1 男 2 女
className:’’,
birthday:’’,
otherCards:[{
imei:2313123
name:小明
}]
}
}

数据接口定义
备注
1、调用结果以json格式返回
2、接口地址: /logout
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
登录得到的token字符串

数据接口定义
备注
1、调用结果以json格式返回
2、接口地址: /setNewPassword
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
phoneNumber
手机号
字符串
2
老密码
oldPassword
字符串
3
新密码
newPassword
字符串
4
token
token
字符串
需要返回的数据
{
"msg": “成功”,
"code": “0000”
}

数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:/setStudentInfo
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
3
学生
name
字符串
4
性别
sex
字符串
5
班级名称
className
字符串
6
生日
birthday
字符串
需要返回的数据
{
"msg": “成功”,
"code":“0000”
}
学生卡主动定位接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址: /card/getCardLocation
输入字段定义
序号
字段名称
字段定义
数据类型
备注
1
token
token
字符串
需要返回的数据:
{
"batteryValue": 100, //电量
"data": {
"locationType": 1,//定位类型 GPS 0,北斗 1,基站 2.
"coord": {
"latitude": ,
"longitude":
}
},
"updateTime": 15452154,//更新时间
"msg":