Showing
1 changed file
with
83 additions
and
0 deletions
班主任/班主任.md
0 → 100644
1 | +> env.url: `https`://api[api-online.test].boxfish.cn | ||
2 | +> | ||
3 | +> notes: | ||
4 | +> | ||
5 | + * `默认所有接口都要携带token` access_token | ||
6 | + | ||
7 | +# 班主任接口 | ||
8 | +## 今日学情接口 | ||
9 | + * URL {env.url}/clazz/consultant/user/plan/learning | ||
10 | + * GET Method | ||
11 | + * path 参数: | ||
12 | + * request 参数: | ||
13 | + * response: | ||
14 | + | ||
15 | + | 变量名 | 类型 | 必填 | 说明 | 示例 | | ||
16 | + |-------------|--------|------|----------|------| | ||
17 | + | unfinished | List | Y | 未完成学生列表 | | | ||
18 | + | finished | List | Y | 已完成学生列表| | | ||
19 | + | ||
20 | + * 学生列表: | ||
21 | + | ||
22 | + | 变量名 | 类型 | 必填 | 说明 | 示例 | | ||
23 | + |-------------|--------|------|----------|------| | ||
24 | + | user_id | Long | Y | id | | | ||
25 | + | user_real_name | String | Y |用户名字 | | ||
26 | + | figure_url | String | Y | 头像| | | ||
27 | + | courses | List | N | 已完成课程列表| | | ||
28 | + | lesson | String | Y | 课程ID| | | ||
29 | + | course_type_group_type | List | Y | 课程类型| | | ||
30 | + | course_type_group_name | List | Y | 课程类型显示名| | | ||
31 | + | completion_grade | List | Y | 成绩| | | ||
32 | + | ||
33 | + | ||
34 | + ```json | ||
35 | + { | ||
36 | + "unfinished": [{ | ||
37 | + "user_id": 9200, | ||
38 | + "user_real_name": "吕寰", | ||
39 | + "figure_url": "https://avatars.boxfish.cn/user/9200/figure/1516946382.jpg" | ||
40 | + }], | ||
41 | + "finished": [{ | ||
42 | + "user_id": 7566, | ||
43 | + "user_real_name": "low", | ||
44 | + "figure_url": "https://avatars.boxfish.cn/user/7566/figure/1563170627.jpg", | ||
45 | + "courses": [{ | ||
46 | + "lesson": "L3NoYXJlL3N2bi9MZXZlbCAzX0Z1bmN0aW9uMS8wMjgu5aaC5L2V6K-i6Zeu5LuK5aSp5piv5ZGo5Yeg77yfLnhsc3g", | ||
47 | + "course_type_group_type": "KNOWLEDGE", | ||
48 | + "course_type_group_name": "AI知识点拓展课", | ||
49 | + "completion_grade": "C" | ||
50 | + }, | ||
51 | + { | ||
52 | + "lesson": "L3NoYXJlL3N2bi9MZXZlbCAyX-WNleivjeeUqOazlTIvMjEyLuWNleivjeeUqOazlV93ZWVrIOaYn-acn-Wbm-WIsOaYn-acn-aXpS54bHN4", | ||
53 | + "course_type_group_type": "KNOWLEDGE", | ||
54 | + "course_type_group_name": "AI知识点拓展课", | ||
55 | + "completion_grade": "A_PLUS" | ||
56 | + } | ||
57 | + ] | ||
58 | + }] | ||
59 | + } | ||
60 | + ``` | ||
61 | + | ||
62 | +## 用户规划课程接口 | ||
63 | + * URL {env.url}/clazz/consultant/user/{userId}/plan/course | ||
64 | + * GET Method | ||
65 | + * path 参数: | ||
66 | + | ||
67 | + | 变量名 | 类型 | 必填 | 说明 | 示例 | | ||
68 | + |-------------|--------|------|----------|------| | ||
69 | + | userId | Long | Y | 学生id| | | ||
70 | + | ||
71 | + * request 参数: | ||
72 | + * response: | ||
73 | + | ||
74 | + | 变量名 | 类型 | 必填 | 说明 | 示例 | | ||
75 | + |-------------|--------|------|----------|------| | ||
76 | + | user_id | Long | Y | id | | | ||
77 | + | user_real_name | String | Y | 用户名| | | ||
78 | + | figure_url | String | Y | 用户名| | | ||
79 | + | user_with_mobile | String | Y | 用户手机号| | | ||
80 | + | plan_days | String | Y | 规划的时间| | | ||
81 | + | plan_course_count_info | String | Y | 课程完成情况| | | ||
82 | + | version | String | Y | 用户名| | | ||
83 | + | user_plan_course | List | Y | 用户名| | |
-
Please register or login to post a comment