chong

Updates 家长端服务/接口文档.md

Auto commit by GitBook Editor
... ... @@ -2,19 +2,19 @@
### 1. 流程逻辑介绍
家长登录app,首先进行自动注册&登录;
之后输入学生绑定的手机号,会想学生手机发送验证码;
家长登录app,首先进行自动注册&登录;
之后输入学生绑定的手机号,会想学生手机发送验证码;
输入验证码后.完成家长和学生的绑定.
学生在提交学习时长是,会被计入今日学习时长的统计;
学生在提交学习时长是,会被计入今日学习时长的统计;
学生提交课程成绩时,会计入课程学习和今日学习时长的统计.
### 2. 接口文档
(1) 注册 /signup POST
\(1\) 注册 /signup POST
```
参数:
参数:
type auto
返回值:
{
... ... @@ -23,10 +23,10 @@
}
```
\(2\) 登录
(2) 登录
```
URL :
URL :
/login POST
参数 :
username: user161116141352CJHaqctY
... ... @@ -38,19 +38,21 @@
}
失败时code不为success 在msg字段中获取失败原因
```
(3) 家长发送学生验证码 POST
\(3\) 家长发送学生验证码 POST
```
返回值: 200 OK
返回值: 200 OK
错误时: 400
{
"message": "您已是该手机号对应账号的家长"
}
```
(4) 家长确认绑定 POST
\(4\) 家长确认绑定 POST
```
URL: /parents/family/mobile/accept/15504612470/4642?access_token=admin
URL: /parents/family/mobile/accept/15504612470/4642?access_token=admin
返回值: 200 OK
错误时: 400
{
... ... @@ -58,12 +60,10 @@
}
```
(5) 家长查询学生 GET
\(5\) 家长查询学生 GET
```
URL: /parents/family/students?access_token=admin
URL: /parents/family/students?access_token=admin
返回值:
[
{
... ... @@ -76,20 +76,24 @@
"createAt": "2016-11-16T16:11:16.311"
}
]
```
### 3. 数据库设计
表名:
family_relation : 保存家长和学生关系的表
family_relation_invite : 家长邀请学生加入关系的表
student_lesson_learning : 学生课程学习表
student_day_learning : 学生当日学习表
```
表名:
family_relation : 保存家长和学生关系的表
family_relation_invite : 家长邀请学生加入关系的表
student_lesson_learning : 学生课程学习表
student_day_learning : 学生当日学习表
```
### 4. 统计逻辑
在/event/behavoiur/push接口中,添加了学习时长统计;
在/event/statistic/exam/progress & /event/progress/article/progress 接口中,添加了学生今日学习和课程学习的统计.
```
在/event/behavoiur/push接口中,添加了学习时长统计;
在/event/statistic/exam/progress & /event/progress/article/progress 接口中,添加了学生今日学习和课程学习的统计.
```
... ...