通用App接口定义文档规范Word文档格式.docx
- 文档编号:22268365
- 上传时间:2023-02-03
- 格式:DOCX
- 页数:21
- 大小:22.59KB
通用App接口定义文档规范Word文档格式.docx
《通用App接口定义文档规范Word文档格式.docx》由会员分享,可在线阅读,更多相关《通用App接口定义文档规范Word文档格式.docx(21页珍藏版)》请在冰豆网上搜索。
StringNO_PERMISSION="
UP01"
StringNO_PERMISSION_MSG="
无接口访问权限"
StringUE01="
UE01"
StringUE01_MSG="
未知接口异常"
测试服务器调试路径
登录逻辑附件如下:
1.接口服务器验证接口
数据接口定义
备注
1、调用结果以json格式返回
2、接口地址:
/loginvalidate
输入字段定义
序号
字段名称
字段定义
数据类型
1
手机号
phoneNumber
字符串
2
token
需要返回的数据
"
msg"
:
“成功”,
"
code"
“0000”
token:
’’
role:
’1’;
贝信息设置接口
/setStudentInfo
3
学生姓名
name
4
性别
sex
5
班级名称
className
6
生日
birthday
}
3.学生卡主动定位接口
/card/getCardLocation
需要返回的数据:
batteryValue"
100,"
coord"
{
latitude"
longitude"
}
},
4."
updateTime"
.等等等
],
updatetime"
‘0000’
‘msg’:
’成功’
5.亲情号设置接口
/card/setQinqinghao
亲情号码
numbers
List<
QH>
的Json字符串
Qinqinghao{
name:
’妈妈’
phoneNum:
6.获取宝贝信息
/card/getStudentInfo
Imei号
imei
Long
data"
childBirthday"
1,
childGrade"
childName"
childSex"
1
取上课隐身接口
/card/getHide
count"
4,
[
repeatCycleMode"
012"
timeEnd"
19:
00"
timeStart"
8:
“openState”:
0置上课隐身接口
/card/setHide
上课隐身对象List
hideTimes
HideTime>
json字符串
HideTime{
/**
*开始小时
*/
privateintstartHour;
/**
*开始分钟
privateintstartMinute;
*结束小时
privateintendHour;
*结束分钟
privateintendMinute;
*模式,参考本类静态变量
privateintmode;
privateStringenabled;
表示是否启用字符串1表示启用,0表示不启用
9.获取闹钟接口
/card/getClock
2,
alarmsName"
起床"
openState"
true,
time"
9:
午休"
false,
234"
10:
200
成功
10.设置闹钟接口
/card/setClock
闹钟身对象List
clocks
Clock>
Clock{
"
"
11.获取一键拨号接口
/card/getOneKey
[‘’,’’,’’,’’]置一键拨号接口
/card/setOneKey
一键拨号
onekeys
4位的电话号码数字没有的填0
例如:
0,,0,
代笔#1为空#2#3为空#4
13.设置休眠接口
/card/setSleep
是否休眠
isSleep
Boolean
14.发起远程监听接口
/card/getRemoteMonitoring
类型
type
String
1代表录音
2代表电话回拨
电话号码
回拨的电话号码
15.远程关机接口
/card/remoteClose
16.意见反馈接口
/suggest
可选
必填
content
内容
长度大于10个字(必填)
imgFile
图片
二进制数据
17.学生卡解绑接口
/card/unBind
必填
adminNumber
管理员手机号
LONG
password
管理员密码
18.更换管理员号码
/card/changeAdminNumber
oldAdminNumber
老管理员号码
newAdminNumber
新管理员号码
deleteHistory
是否删除历史轨迹
BOOLEAN
必填(true,false)
smsValidateCode
短信验证码
19.获取休眠接口
/card/getSleep
“data”:
”true”询蓝牙状态接口
/card/queryBlueTooth
”1”置蓝牙接口
/card/setBlueTooth
on
开启、关闭
True,false
22.设置定位周期接口
/card/setDingWeiPeriod
second
秒数
int
23.获取短信验证码
/card/getVaildCode
手机号码
24.设置音量
/card/setVolume
naozhongVolume
闹钟音量
xianglingVolume
响铃音量
tonghuaVolume
通话音量
25.获取音量
/card/getVolume
”7;
7;
7”;
置自动开关机
/card/setPowerOnOff
powerOnOff
PowerOnOff对象
PowerOnOff{
privatelongimei;
privateintonHour;
privateintonMinute;
*模式,以7个0或者1表示,单次不重复是0000000,每星期二星期三重复是0110000
privateStringonMode;
privatebooleanonEnabled;
privateintoffHour;
privateintoffMinute;
privateStringoffMode;
privatebooleanoffEnabled;
取自动开关机
/card/getAutoPowerOnOff
{imei:
onHour:
1……}询话费
/card/queryLeftMoney
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 通用 App 接口 定义 文档 规范
![提示](https://static.bdocx.com/images/bang_tan.gif)