chong

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

Auto commit by GitBook Editor
@@ -2,19 +2,19 @@ @@ -2,19 +2,19 @@
2 2
3 ### 1. 流程逻辑介绍 3 ### 1. 流程逻辑介绍
4 4
5 - 家长登录app,首先进行自动注册&登录; 5 + 家长登录app,首先进行自动注册&登录;
6 - 之后输入学生绑定的手机号,会想学生手机发送验证码; 6 + 之后输入学生绑定的手机号,会想学生手机发送验证码;
7 输入验证码后.完成家长和学生的绑定. 7 输入验证码后.完成家长和学生的绑定.
8 8
9 - 学生在提交学习时长是,会被计入今日学习时长的统计; 9 + 学生在提交学习时长是,会被计入今日学习时长的统计;
10 学生提交课程成绩时,会计入课程学习和今日学习时长的统计. 10 学生提交课程成绩时,会计入课程学习和今日学习时长的统计.
11 11
12 ### 2. 接口文档 12 ### 2. 接口文档
13 13
14 - (1) 注册 /signup POST 14 +\(1\) 注册 /signup POST
15 15
16 ``` 16 ```
17 - 参数: 17 +参数:
18 type auto 18 type auto
19 返回值: 19 返回值:
20 { 20 {
@@ -23,10 +23,10 @@ @@ -23,10 +23,10 @@
23 } 23 }
24 ``` 24 ```
25 25
  26 +\(2\) 登录
26 27
27 - (2) 登录  
28 ``` 28 ```
29 - URL : 29 +URL :
30 /login POST 30 /login POST
31 参数 : 31 参数 :
32 username: user161116141352CJHaqctY 32 username: user161116141352CJHaqctY
@@ -38,19 +38,21 @@ @@ -38,19 +38,21 @@
38 } 38 }
39 失败时code不为success 在msg字段中获取失败原因 39 失败时code不为success 在msg字段中获取失败原因
40 ``` 40 ```
41 - (3) 家长发送学生验证码 POST 41 +
  42 +\(3\) 家长发送学生验证码 POST
  43 +
42 ``` 44 ```
43 - 返回值: 200 OK 45 +返回值: 200 OK
44 错误时: 400 46 错误时: 400
45 { 47 {
46 "message": "您已是该手机号对应账号的家长" 48 "message": "您已是该手机号对应账号的家长"
47 } 49 }
48 ``` 50 ```
49 51
50 - (4) 家长确认绑定 POST 52 +\(4\) 家长确认绑定 POST
51 53
52 ``` 54 ```
53 - URL: /parents/family/mobile/accept/15504612470/4642?access_token=admin 55 +URL: /parents/family/mobile/accept/15504612470/4642?access_token=admin
54 返回值: 200 OK 56 返回值: 200 OK
55 错误时: 400 57 错误时: 400
56 { 58 {
@@ -58,12 +60,10 @@ @@ -58,12 +60,10 @@
58 } 60 }
59 ``` 61 ```
60 62
61 - 63 +\(5\) 家长查询学生 GET
62 - (5) 家长查询学生 GET  
63 -  
64 64
65 ``` 65 ```
66 - URL: /parents/family/students?access_token=admin 66 +URL: /parents/family/students?access_token=admin
67 返回值: 67 返回值:
68 [ 68 [
69 { 69 {
@@ -76,20 +76,24 @@ @@ -76,20 +76,24 @@
76 "createAt": "2016-11-16T16:11:16.311" 76 "createAt": "2016-11-16T16:11:16.311"
77 } 77 }
78 ] 78 ]
79 -  
80 ``` 79 ```
81 80
82 -  
83 ### 3. 数据库设计 81 ### 3. 数据库设计
84 82
85 - 表名: 83 +```
86 - family_relation : 保存家长和学生关系的表 84 +表名:
87 - family_relation_invite : 家长邀请学生加入关系的表 85 + family_relation : 保存家长和学生关系的表
88 - student_lesson_learning : 学生课程学习表 86 + family_relation_invite : 家长邀请学生加入关系的表
89 - student_day_learning : 学生当日学习表 87 + student_lesson_learning : 学生课程学习表
  88 + student_day_learning : 学生当日学习表
  89 +```
90 90
91 ### 4. 统计逻辑 91 ### 4. 统计逻辑
92 92
93 - 在/event/behavoiur/push接口中,添加了学习时长统计; 93 +```
94 - 在/event/statistic/exam/progress & /event/progress/article/progress 接口中,添加了学生今日学习和课程学习的统计. 94 +在/event/behavoiur/push接口中,添加了学习时长统计;
95 - 95 +在/event/statistic/exam/progress & /event/progress/article/progress 接口中,添加了学生今日学习和课程学习的统计.
  96 +```
  97 +
  98 +
  99 +