接口文档.md
2.44 KB
家长服务接口
用户注册
POST https://api.boxfish.cn/signup
参数
Name | Type | Descripton |
---|---|---|
type | String | 必须。自动注册 |
返回值
{
"username": "user161116141854MKyNqTI3",
"status": "success"
}
登录
POST https://api.boxfish.cn/login
参数
Name | Type | Descripton |
---|---|---|
username | String | 必须. |
返回值
成功
{
"access_token": "CxCIFCdSFu",
"id": 70904,
"code": "success"
}
失败
{
"code":"fail",
"msg":"失败具体原因"
}
家长发送学生验证码 POST
POST https://api.boxfish.cn/parents/family/mobile/invite/15504612470?access_token=admin
返回值: 200 OK
错误时: 400
{
"message": "您已是该手机号对应账号的家长"
}
家长确认绑定
POST https://api.boxfish.cn/parents/family/mobile/accept/{mobile}/{code}?access_token=admin
Name | Type | Desc |
---|---|---|
mobile | String | 必须.被绑定用户手机号 |
code | String | 必须.短信验证码 |
返回值
成功
http code 200
失败
http code 400
{
"message": "失败具体原因!"
}
家长查询学生
GET https://api.boxfish.cn/parents/family/students?access_token=admin
返回值
[
{
"stuId": 1,
"parentId": 246825,
"stuName": "盒子鱼",
"parentName": "qqqqqqq",
"stuFigureUrl": null,
"parentFigureUrl":"http://q.qlogo.cn/qqapp/101019284/2A80E4F65BDD755D4181059D9755696B/100",
"createAt": "2016-11-16T16:11:16.311"
}
]
用户首页词义等级信息
GET https://api.boxfish.cn/parents/{stuId}/info?access_token=admin
Name |
---|
Type | Desc | |
---|---|---|
mobile | String | 必须.被绑定用户手机号 |
code | String | 必须.短信验证码 |
3. 数据库设计
表名:
family_relation : 保存家长和学生关系的表
family_relation_invite : 家长邀请学生加入关系的表
student_lesson_learning : 学生课程学习表
student_day_learning : 学生当日学习表
4. 统计逻辑
在/event/behavoiur/push接口中,添加了学习时长统计;
在/event/statistic/exam/progress & /event/progress/article/progress 接口中,添加了学生今日学习和课程学习的统计.