Track 2 files into repository.
- modified 家长端服务/接口文档.md - removed 接口文档.md Auto commit by GitBook Editor
Showing
2 changed files
with
68 additions
and
68 deletions
1 | +# pub-家长服务 | ||
2 | + | ||
3 | +### 1. 流程逻辑介绍 | ||
4 | + | ||
5 | + 家长登录app,首先进行自动注册&登录; | ||
6 | + 之后输入学生绑定的手机号,会想学生手机发送验证码; | ||
7 | + 输入验证码后.完成家长和学生的绑定. | ||
8 | + | ||
9 | + 学生在提交学习时长是,会被计入今日学习时长的统计; | ||
10 | + 学生提交课程成绩时,会计入课程学习和今日学习时长的统计. | ||
11 | + | ||
12 | +### 2. 接口文档 | ||
13 | + | ||
14 | + (1) 注册 /signup POST | ||
15 | + 参数: | ||
16 | + type auto | ||
17 | + 返回值: | ||
18 | + { | ||
19 | + "username": "user161116141854MKyNqTI3", | ||
20 | + "status": "success" | ||
21 | + } | ||
22 | + (2) 登录 /login POST | ||
23 | + 参数 : | ||
24 | + username: user161116141352CJHaqctY | ||
25 | + 返回值: | ||
26 | + { | ||
27 | + "access_token": "CxCIFCdSFu", | ||
28 | + "id": 70904, | ||
29 | + "code": "success" | ||
30 | + } | ||
31 | + 失败时code不为success 在msg字段中获取失败原因 | ||
32 | + | ||
33 | + (3) 家长发送学生验证码 POST | ||
34 | + /parents/family/mobile/invite/15504612470?access_token=admin | ||
35 | + 返回值: 200OK | ||
36 | + 错误时: 400 {"message": "您已是该手机号对应账号的家长"} | ||
37 | + (4) 家长确认绑定 POST | ||
38 | + /parents/family/mobile/accept/15504612470/4642?access_token=admin | ||
39 | + 返回值: 200OK | ||
40 | + 错误时: 400 {"message": "您已是该手机号对应账号的家长"} | ||
41 | + (5) 家长查询学生 GET | ||
42 | + /parents/family/students?access_token=admin | ||
43 | + 返回值: | ||
44 | + [ | ||
45 | + { | ||
46 | + "stuId": 1, | ||
47 | + "parentId": 246825, | ||
48 | + "stuName": "盒子鱼", | ||
49 | + "parentName": "qqqqqqq", | ||
50 | + "stuFigureUrl": null, | ||
51 | + "parentFigureUrl": "http://q.qlogo.cn/qqapp/101019284/2A80E4F65BDD755D4181059D9755696B/100", | ||
52 | + "createAt": "2016-11-16T16:11:16.311" | ||
53 | + } | ||
54 | + ] | ||
55 | + | ||
56 | +### 3. 数据库设计 | ||
57 | + | ||
58 | + 表名: | ||
59 | + family_relation : 保存家长和学生关系的表 | ||
60 | + family_relation_invite : 家长邀请学生加入关系的表 | ||
61 | + student_lesson_learning : 学生课程学习表 | ||
62 | + student_day_learning : 学生当日学习表 | ||
63 | + | ||
64 | +### 4. 统计逻辑 | ||
65 | + | ||
66 | + 在/event/behavoiur/push接口中,添加了学习时长统计; | ||
67 | + 在/event/statistic/exam/progress & /event/progress/article/progress 接口中,添加了学生今日学习和课程学习的统计. | ||
68 | + |
接口文档.md
deleted
100644 → 0
1 | -# pub-家长服务 | ||
2 | - | ||
3 | -### 1. 流程逻辑介绍 | ||
4 | - | ||
5 | - 家长登录app,首先进行自动注册&登录; | ||
6 | - 之后输入学生绑定的手机号,会想学生手机发送验证码; | ||
7 | - 输入验证码后.完成家长和学生的绑定. | ||
8 | - | ||
9 | - 学生在提交学习时长是,会被计入今日学习时长的统计; | ||
10 | - 学生提交课程成绩时,会计入课程学习和今日学习时长的统计. | ||
11 | - | ||
12 | -### 2. 接口文档 | ||
13 | - | ||
14 | - (1) 注册 /signup POST | ||
15 | - 参数: | ||
16 | - type auto | ||
17 | - 返回值: | ||
18 | - { | ||
19 | - "username": "user161116141854MKyNqTI3", | ||
20 | - "status": "success" | ||
21 | - } | ||
22 | - (2) 登录 /login POST | ||
23 | - 参数 : | ||
24 | - username: user161116141352CJHaqctY | ||
25 | - 返回值: | ||
26 | - { | ||
27 | - "access_token": "CxCIFCdSFu", | ||
28 | - "id": 70904, | ||
29 | - "code": "success" | ||
30 | - } | ||
31 | - 失败时code不为success 在msg字段中获取失败原因 | ||
32 | - | ||
33 | - (3) 家长发送学生验证码 POST | ||
34 | - /parents/family/mobile/invite/15504612470?access_token=admin | ||
35 | - 返回值: 200OK | ||
36 | - 错误时: 400 {"message": "您已是该手机号对应账号的家长"} | ||
37 | - (4) 家长确认绑定 POST | ||
38 | - /parents/family/mobile/accept/15504612470/4642?access_token=admin | ||
39 | - 返回值: 200OK | ||
40 | - 错误时: 400 {"message": "您已是该手机号对应账号的家长"} | ||
41 | - (5) 家长查询学生 GET | ||
42 | - /parents/family/students?access_token=admin | ||
43 | - 返回值: | ||
44 | - [ | ||
45 | - { | ||
46 | - "stuId": 1, | ||
47 | - "parentId": 246825, | ||
48 | - "stuName": "盒子鱼", | ||
49 | - "parentName": "qqqqqqq", | ||
50 | - "stuFigureUrl": null, | ||
51 | - "parentFigureUrl": "http://q.qlogo.cn/qqapp/101019284/2A80E4F65BDD755D4181059D9755696B/100", | ||
52 | - "createAt": "2016-11-16T16:11:16.311" | ||
53 | - } | ||
54 | - ] | ||
55 | - | ||
56 | -### 3. 数据库设计 | ||
57 | - | ||
58 | - 表名: | ||
59 | - family_relation : 保存家长和学生关系的表 | ||
60 | - family_relation_invite : 家长邀请学生加入关系的表 | ||
61 | - student_lesson_learning : 学生课程学习表 | ||
62 | - student_day_learning : 学生当日学习表 | ||
63 | - | ||
64 | -### 4. 统计逻辑 | ||
65 | - | ||
66 | - 在/event/behavoiur/push接口中,添加了学习时长统计; | ||
67 | - 在/event/statistic/exam/progress & /event/progress/article/progress 接口中,添加了学生今日学习和课程学习的统计. | ||
68 | - |
-
Please register or login to post a comment