文档介绍：通用App接口定义文档规范
通用App接口定义文档规范
1 / 151
通用App接口定义文档规范
阅读以前（必读 *）：
全部接口返回数据格式为
{
code:’0000’,
msg:’’,
data:{}
}
的QH>的Json字符串
Qinqinghao{
name: ’妈妈’
phoneNum:’’
}
需要返回的数据 :
{
"code": ‘0000’
‘msg’:’成功’
}
通用App接口定义文档规范
通用App接口定义文档规范
9 / 159
通用App接口定义文档规范
获得宝贝信息
数据接口定义
备注
1、调用结果以json
格式返回
2、接口地点:/card/getStudentInfo
输入字段定义
序号
字段名称
字段定义
数据种类
备注
1
Imei号
imei
Long
需要返回的数据 :
{
"data":{
"childBirthday":1,
"childGrade":"",
"childName":"",
"childSex":1
取上课隐身接口
数据接口定义
备注
1、调用结果以json
格式返回
2、接口地点:/card/getHide
输入字段定义
序号
字段名称
字段定义
数据种类
备注
1
token
token
字符串
需要返回的数据 :
{
"count":4,
"data":[
{
"repeatCycleMode":"012",
"timeEnd":"19:00",
"timeStart":"8:00",
通用App接口定义文档规范
通用App接口定义文档规范
10 / 1510
通用App接口定义文档规范
“openState”:0置上课隐身接口
数据接口定义
备注
1、调用结果以json
格式返回
2、接口地点:/card/setHide
输入字段定义
序号
字段名称
字段定义
数据种类
备注
1
token
token
字符串
2
上课隐身对象
hideTimes
字符串
List<HideTime>json字
List
符串
HideTime{
/**
开始小时
*/
private int startHour ;
/**
开始分钟
*/
private int startMinute ;
/**
结束小时
*/
private int endHour;
/**
结束分钟
*/
private int endMinute;
/**
模式，参照本类静态变量
*/
private int mode;
private String enabled; 表示能否启用 字符串1表示启用，0表示不启用
}
获得闹钟接口
数据接口定义
1、调用结果以 json 格式返回
备注
2、接口地点:/card/getClock
通用App接口定义文档规范
通用App接口定义文档规范
11 / 1511
通用App接口定义文档规范
输入字段定义
通用App接口定义文档规范
通用App接口定义文档规范
12 / 1512
通用App接口定义文档规范
序号
1
字段名称
token
字段定义
token
数据种类
字符串
备注
通用App接口定义文档规范
通用App接口定义文档规范
15 / 1515
通用App接口定义文档规范
需要返回的数据 :
{
"count":2,
"data":[
{
"alarmsName":" 起床",
"openState":true,
"repeatCycleMode":"012",
"time":"9:00"
},
{
"alarmsName":" 午睡",
"openState":false,
"repeatCycleMode":"234",
"time":"10:00"
}
],
"code":200
"msg": 成功
}
设置闹钟接口
数据接口定义
备注
1、调用结果以json
格式返回
2、接口地点:/card/setClock
输入字段定义
序号