通用app接口定义文档规范

通用app接口定义文档规范

ID:11054059

大小:278.00 KB

页数:19页

时间:2018-07-09

通用app接口定义文档规范_第1页
通用app接口定义文档规范_第2页
通用app接口定义文档规范_第3页
通用app接口定义文档规范_第4页
通用app接口定义文档规范_第5页
资源描述:

《通用app接口定义文档规范》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库

1、阅读之前(必读*):1.所有接口返回数据格式为{code:’0000’,msg:’’,data:{}}的形式其中code是响应码msg是响应消息默认正确响应无msg消息只有错误才有错误消息data为数据段.Java段对应返回数据bean为如下形式。2.响应码表对应codeStringSUCCESS="0000";StringSUCCESS_MSG="成功";StringERROR="0001";StringERROR_MSG="失败";StringPARAM_ERROR="0002";Strin

2、gPARAM_ERROR_MSG="参数错误或者参数不完整";StringNO_PERMISSION="UP01";StringNO_PERMISSION_MSG="无接口访问权限";StringUE01="UE01";StringUE01_MSG="未知接口异常";测试服务器调试路径http://115.159.28.17/ssm3登录逻辑附件如下:191.接口服务器验证接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/loginvalidate输入字段定义序号字段名称字段定义

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

4、口地址:/logout输入字段定义序号字段名称字段定义数据类型备注191tokentoken字符串登录得到的token字符串1.2修改密码接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/setNewPassword输入字段定义序号字段名称字段定义数据类型备注1phoneNumber手机号字符串2老密码oldPassword字符串3新密码newPassword字符串4tokentoken字符串需要返回的数据{"msg":“成功”,"code":“0000”}2.宝贝信息设置接口数

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

6、注1tokentoken字符串需要返回的数据:{"batteryValue":100,//电量"data":{"locationType":1,//定位类型GPS0,北斗1,基站2."coord":{"latitude":22.566235,"longitude":113.90045}},"updateTime":15452154,//更新时间"msg":“成功”,"code":“0000”}2.围栏列表查询接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/getWei

7、Lan输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据:{"count":3,"data":[{“meter”:123123“name”:’学校’//围栏名称“gpsPointWeidu”:23.123123//中心纬度19“gpsPointJingdu”:132.23213123//中心经度}],"code":0000“msg”:”成功”}1.设置围栏接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/setSafeCircles输

8、入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2safeCircles围栏列表字符串围栏列表ListJSON字符串SafeCircle{meter//半径name//围栏名称gpsPointWeidu//中心纬度gpsPointJingdu//中心经度}输出数据格式{"msg":“成功”,"code":“0000”}2.历史轨迹查询接口19数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/getHistoryLocation输

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。