Showing
4 changed files
with
399 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}/user/{userId}/lesson/{courseId}/learning | ||
10 | + * GET Method | ||
11 | + * path 参数: | ||
12 | + | ||
13 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
14 | + |-------------|--------|------|----------|------| | ||
15 | + | userId | Long | Y | 学生id| 7566 | | ||
16 | + | courseId | String | Y | app课程id| | | ||
17 | + * request 参数: | ||
18 | + | ||
19 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
20 | + |-------------|--------|------|----------|------| | ||
21 | + | paper | boolean | Y | 是否是纸质课程| | | ||
22 | + | ||
23 | + * response: | ||
24 | + | ||
25 | + * 课程未完成 | ||
26 | + | ||
27 | + | 变量名 | 类型 | 必填 | 说明 | 示例 | | ||
28 | + |-------------|--------|------|----------|------| | ||
29 | + | key_knowledge | List | Y | 核心知识点 | | | ||
30 | + | words | List | Y | 本课单词 | | | ||
31 | + | phrases | List | Y | 本课短语 | | | ||
32 | + | course_finished | boolean | Y | 课程是否完成 | | | ||
33 | + | ||
34 | + ``` | ||
35 | + { | ||
36 | + "key_knowledge": [ | ||
37 | + "天气weather: hot/cold/warm/cool" | ||
38 | + ], | ||
39 | + "words": [ | ||
40 | + "be", | ||
41 | + "like", | ||
42 | + "cool" | ||
43 | + ], | ||
44 | + "phrases": [], | ||
45 | + "course_finished": false | ||
46 | + } | ||
47 | + ``` | ||
48 | + * 课程完成一部分 | ||
49 | + | ||
50 | + | 变量名 | 类型 | 必填 | 说明 | 示例 | | ||
51 | + |-------------|--------|------|----------|------| | ||
52 | + | course_finished | boolean | Y | 课程是否完成 | | | ||
53 | + | review_class | boolean | Y | 是否可以外教练习 | | | ||
54 | + | paper_detail | Object | N | 纸质识别结果,参考纸质识别接口 | 待补充链接地址| | ||
55 | + | course | List | N | 课程完成进度 | 待补充 | | ||
56 | + | ||
57 | + ``` | ||
58 | + { | ||
59 | + "course_finished": true, | ||
60 | + "review_class": true, | ||
61 | + "paper_detail": { | ||
62 | + "user_id": 100000007078, | ||
63 | + "paperHasPart": true, | ||
64 | + "paperHasWriting": false, | ||
65 | + "summaryQuestionAmountAll": 7, | ||
66 | + "summaryQuestionAmountCorrect": 7, | ||
67 | + "summaryQuestionAmountWrong": 0, | ||
68 | + "summaryQuestionRateCorrect": 1, | ||
69 | + "summaryCompositionAdviceAmount": 0, | ||
70 | + "questions": [{ | ||
71 | + "number": "1", | ||
72 | + "correct": true | ||
73 | + }, | ||
74 | + { | ||
75 | + "number": "2", | ||
76 | + "correct": true | ||
77 | + }, | ||
78 | + { | ||
79 | + "number": "3", | ||
80 | + "correct": true | ||
81 | + }, | ||
82 | + { | ||
83 | + "number": "4", | ||
84 | + "correct": true | ||
85 | + }, | ||
86 | + { | ||
87 | + "number": "5", | ||
88 | + "correct": true | ||
89 | + }, | ||
90 | + { | ||
91 | + "number": "6", | ||
92 | + "correct": true | ||
93 | + }, | ||
94 | + { | ||
95 | + "number": "7", | ||
96 | + "correct": true | ||
97 | + } | ||
98 | + ], | ||
99 | + "partList": [], | ||
100 | + "compositionAdviceList": [], | ||
101 | + "imageUrls": [ | ||
102 | + "image/100000007078/20190111/1547187782.jpg", | ||
103 | + "image/100000007078/20190111/1547187786.jpg" | ||
104 | + ], | ||
105 | + "superviseVoiceAmount": 0 | ||
106 | + }, | ||
107 | + "course": [{ | ||
108 | + "id": "L3NoYXJlL3N2bi9MZXZlbCA0X0NvbnZlcnNhdGlvbjUvMDAxLuS9oOacieKAnOW8gOWtpuaBkOaDp-eXh-KAneWQl--8ny54bHN4", | ||
109 | + "student": false, | ||
110 | + "teacher": false, | ||
111 | + "isAllUnFinished": false, | ||
112 | + "course_type": "CONVERSATION", | ||
113 | + "course_type_v2": "PROBLEM_SOLVING", | ||
114 | + "review_class": true, | ||
115 | + "national_knowledge": [ | ||
116 | + "a little bit", | ||
117 | + "What happened?", | ||
118 | + "what引导的特殊疑问句", | ||
119 | + "个人生活-个人情感", | ||
120 | + "表达情感-害怕" | ||
121 | + ], | ||
122 | + "international_knowledge": [ | ||
123 | + "克服开学恐惧" | ||
124 | + ], | ||
125 | + "paper_rage": 1, | ||
126 | + "paper_id": "L3NoYXJlL3N2bi9MZXZlbCA0X0NvbnZlcnNhdGlvbjUvMDAxLuS9oOacieKAnOW8gOWtpuaBkOaDp-eXh-KAneWQl--8ny54bHN4", | ||
127 | + "key_knowledge": "a little bit", | ||
128 | + "is_paper": true, | ||
129 | + "total_completion_grade": 2, | ||
130 | + "paper_rate_score": 100 | ||
131 | + }] | ||
132 | + } | ||
133 | + ``` | ||
134 | + |
中教版/老师便好设置相关接口.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}/teacher/preference | ||
10 | + * GET Method | ||
11 | + * path 参数: | ||
12 | + * request 参数: | ||
13 | + * response: | ||
14 | + | ||
15 | + | 变量名 | 类型 | 必填 | 说明 | 示例 | | ||
16 | + |-------------|--------|------|----------|------| | ||
17 | + | relation_material | String | Y |教材版本 | 北京版-五下 | | ||
18 | + | difficulties | List | Y | 难度列表 | | | ||
19 | + | fit_grade | String | Y | 用户真实年级 | | | ||
20 | + | term | String | N | 学期 |[FIRST,SECOND] | | ||
21 | + | grade_name | String | Y | 用户显示年级(转换 初一 等数据) | | | ||
22 | + | ||
23 | + ``` | ||
24 | + { | ||
25 | + "relation_material": "北京版-五下", | ||
26 | + "difficulties": [ | ||
27 | + "1", | ||
28 | + "2", | ||
29 | + "3", | ||
30 | + "4" | ||
31 | + ], | ||
32 | + "fit_grade": "五年级", | ||
33 | + "term": "FIRST", | ||
34 | + "grade_name": "五年级" | ||
35 | + } | ||
36 | + ``` | ||
37 | +## 设置老师便好设置 | ||
38 | + * URL {env.url}/teacher/preference | ||
39 | + * POST Method | ||
40 | + * path 参数: | ||
41 | + * request参数: | ||
42 | + | ||
43 | + | 参数名 | 类型 | 必填 | 说明 | 示例 | | ||
44 | + |-------------|--------|------|----------|------| | ||
45 | + | relation_material | String | Y | 教材版本 | 北京版-五下 | | ||
46 | + | difficulties | String | Y | 难度列表 | 1,2,3| | ||
47 | + | fit_grade | String | Y | 用户选择年级 | | | ||
48 | + | term | String | N | 学期 |[FIRST,SECOND] | | ||
49 | + | ||
50 | +* response: | ||
51 | + | ||
52 | + | 变量名 | 类型 | 必填 | 说明 | 示例 | | ||
53 | + |-------------|--------|------|----------|------| | ||
54 | + | relation_material | String | Y |教材版本 | 北京版-五下 | | ||
55 | + | difficulties | List | Y | 难度列表 | | | ||
56 | + | fit_grade | String | Y | 用户真实年级 | | | ||
57 | + | term | String | N | 学期 |[FIRST,SECOND] | | ||
58 | + | grade_name | String | Y | 用户显示年级(转换 初一 等数据) | | | ||
59 | + ``` | ||
60 | + { | ||
61 | + "relation_material": "北京版-五下", | ||
62 | + "difficulties": [ | ||
63 | + "1", | ||
64 | + "2", | ||
65 | + "3", | ||
66 | + "4" | ||
67 | + ], | ||
68 | + "fit_grade": "五年级", | ||
69 | + "term": "FIRST", | ||
70 | + "grade_name": "五年级" | ||
71 | + } | ||
72 | + ``` | ||
73 | + |
中教版/老师便好设置相关接口的副本.md
0 → 100644
1 | +> env.url: `https`://api[api-online.test].boxfish.cn | ||
2 | +> | ||
3 | +> notes: | ||
4 | +> | ||
5 | + * `默认所有接口都要携带token` access_token | ||
6 | + | ||
7 | +# 新版书架相关接口 | ||
8 | + * URL {env.url}/teacher/textbook/unit/{catalogId} | ||
9 | + * GET Method | ||
10 | + * path 参数: | ||
11 | + | ||
12 | + | 参数名 | 类型 | 必填 | 说明 | 示例 | | ||
13 | + |-------------|--------|------|----------|------| | ||
14 | + | catalogId | Long | Y |目录Id| 100129102 | | ||
15 | + | ||
16 | + * request 参数: | ||
17 | + | ||
18 | + | 参数名 | 类型 | 必填 | 说明 | 示例 | | ||
19 | + |-------------|--------|------|----------|------| | ||
20 | + | unit | String | Y |单元| 100129102 | | ||
21 | + | ||
22 | + * response: | ||
23 | + | ||
24 | + | 变量名 | 类型 | 必填 | 说明 | 示例 | | ||
25 | + |-------------|--------|------|----------|------| | ||
26 | + | contains_paper | boolean | Y |是否包含纸质版本 | 北京版-五下 | | ||
27 | + | list | List | Y | 课程分类列表 | | | ||
28 | + | ||
29 | + 课程分类列表实体 | ||
30 | + | ||
31 | + | 变量名 | 类型 | 必填 | 说明 | 示例 | | ||
32 | + |-------------|--------|------|----------|------| | ||
33 | + | name | String | Y |分类名称 | 巧学重难点 | | ||
34 | + | type | String | Y | 分类类型 | KNOWLEDGE | | ||
35 | + | courses | List | Y | 课程列表| | | ||
36 | + | ||
37 | + 课程列表实体 | ||
38 | + | ||
39 | + | 变量名 | 类型 | 必填 | 说明 | 示例 | | ||
40 | + |-------------|--------|------|----------|------| | ||
41 | + | id | String | Y | 课程id| | | ||
42 | + | name | String | Y | 课程名称 | | | ||
43 | + | knowledge | String | Y |知识点 | | | ||
44 | + | cover | String | Y |课程封面 | | | ||
45 | + | level | String | Y |课程难度 | | | ||
46 | + | lastModified | long | Y |课程最后修改时间 | | | ||
47 | + | student | boolean | Y |是否有学生版 | | | ||
48 | + | teacher | boolean | Y |是否有老师版 | | | ||
49 | + | sequence | String | Y |课程排序(服务器用) | | | ||
50 | + | free | String | Y |是否免费体验课程 true 是| | | ||
51 | + | knowledge_type | String | Y |知识点类型| | | ||
52 | + | course_type | String | Y |课程类型V1 | | | ||
53 | + | course_type_v2 | String | Y |课程类型V2 | | | ||
54 | + | review_class | boolean | Y |是否可以外教练习 | | | ||
55 | + | course_type_group | String | Y |课程类型分组 | | | ||
56 | + | is_paper | boolean | Y |是否是纸质课程 true 是 | | | ||
57 | + | nationalKnowledge | List | N |大纲知识点 | | | ||
58 | + | inrternationalKnowledge | List | N |国际知识点 | | | ||
59 | + | knowledgeSystems | List | N |课程知识点标签(服务器用) | | | ||
60 | + | basic_knowledge | boolean | Y |是否教材知识点课 | | | ||
61 | + | basic_word | boolean | Y |是否是教材单词课 | | | ||
62 | +``` | ||
63 | + { | ||
64 | + "contains_paper": false, | ||
65 | + "list": [{ | ||
66 | + "name": "巧学重难点", | ||
67 | + "type": "KNOWLEDGE", | ||
68 | + "courses": [{ | ||
69 | + "id": "L3NoYXJlL3N2bi9MZXZlbCA0X-WNleivjeeUqOazlTIvMDEzLuWNleivjeeUqOazlV9pbnZlbnQg5LiN5ZCM5b2i5byPLnhsc3g", | ||
70 | + "name": "单词用法_invent 不同形式", | ||
71 | + "knowledge": "invent/inventor/invention", | ||
72 | + "cover": "adee031deb83be386dc730588c35fc8b", | ||
73 | + "level": "4", | ||
74 | + "lastModified": 1560751445986, | ||
75 | + "student": true, | ||
76 | + "teacher": true, | ||
77 | + "sequence": 100, | ||
78 | + "free": true, | ||
79 | + "knowledge_type": "词汇组合与用法", | ||
80 | + "course_type": "WORD", | ||
81 | + "course_type_v2": "WORDS_EXPRESSIONS", | ||
82 | + "review_class": true, | ||
83 | + "course_type_group": "知识点", | ||
84 | + "is_paper": false, | ||
85 | + "nationalKnowledge": [ | ||
86 | + "invent/inventor/invention" | ||
87 | + ], | ||
88 | + "basic_knowledge": true, | ||
89 | + "basic_word": false | ||
90 | + }, | ||
91 | + { | ||
92 | + "id": "L3NoYXJlL3N2bi9MZXZlbCA0X0dyYW1tYXI0LzAwOC7lpoLkvZXooajovr7kuLvliqjlkozooqvliqjvvJ8ueGxzeA", | ||
93 | + "name": "如何表达主动和被动?", | ||
94 | + "knowledge": "被动语态", | ||
95 | + "cover": "5cd63ba9aa1aed08b333a9d67a83fdc0", | ||
96 | + "level": "4", | ||
97 | + "lastModified": 1524917835829, | ||
98 | + "student": true, | ||
99 | + "teacher": true, | ||
100 | + "sequence": 110, | ||
101 | + "free": true, | ||
102 | + "knowledge_type": "语法应用", | ||
103 | + "course_type": "GRAMMAR", | ||
104 | + "course_type_v2": "GRAMMAR_SENTENCES", | ||
105 | + "review_class": true, | ||
106 | + "course_type_group": "知识点", | ||
107 | + "is_paper": false, | ||
108 | + "nationalKnowledge": [ | ||
109 | + "被动语态be done" | ||
110 | + ], | ||
111 | + "basic_knowledge": true, | ||
112 | + "basic_word": false | ||
113 | + }, | ||
114 | + { | ||
115 | + "id": "L3NoYXJlL3N2bi9MZXZlbCA0X0Z1bmN0aW9uMTUvMDUwLiDlpoLkvZXooajovr7nlKjkvZzku4DkuYjvvJ8ueGxzeA", | ||
116 | + "name": "如何表达用作什么?", | ||
117 | + "knowledge": "be used for…", | ||
118 | + "cover": "aa6ed92df59b1eec6f65a3327afe1262", | ||
119 | + "level": "4", | ||
120 | + "lastModified": 1560752502828, | ||
121 | + "student": true, | ||
122 | + "teacher": true, | ||
123 | + "sequence": 90, | ||
124 | + "free": false, | ||
125 | + "knowledgeSystems": [{ | ||
126 | + "knowledgeSystemOne": "communication", | ||
127 | + "knowledgeSystemTwo": "描述特征", | ||
128 | + "knowledgeSystemThree": "功能" | ||
129 | + }], | ||
130 | + "knowledge_type": "功能对话", | ||
131 | + "course_type": "FUNCTION", | ||
132 | + "course_type_v2": "COMMUNICATION", | ||
133 | + "review_class": true, | ||
134 | + "course_type_group": "知识点", | ||
135 | + "is_paper": false, | ||
136 | + "internationalKnowledge": [ | ||
137 | + "描述特征-功能" | ||
138 | + ], | ||
139 | + "nationalKnowledge": [ | ||
140 | + "be used for" | ||
141 | + ], | ||
142 | + "basic_knowledge": true, | ||
143 | + "basic_word": false | ||
144 | + } | ||
145 | + ] | ||
146 | + }] | ||
147 | + } | ||
148 | +``` |
中教版/课程包含学习内容接口.md
0 → 100644
1 | +> env.url: `https`://api[api-online.test].boxfish.cn | ||
2 | +> | ||
3 | +> notes: | ||
4 | +> | ||
5 | + * `默认所有接口都要携带token` access_token | ||
6 | + | ||
7 | +## 课程包含学习内容接口 | ||
8 | + * URL {env.url} | ||
9 | + * GET Method | ||
10 | + * path 参数: | ||
11 | + | ||
12 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
13 | + |-------------|--------|------|----------|------| | ||
14 | + | courseId | String | Y | app课程id| | | ||
15 | + * request: | ||
16 | + * response: | ||
17 | + | ||
18 | + | 变量名 | 类型 | 必填 | 说明 | 示例 | | ||
19 | + |-------------|--------|------|----------|------| | ||
20 | + | key_knowledge | List | Y | 核心知识点 | | | ||
21 | + | words | List | Y | 本课单词 | | | ||
22 | + | phrases | List | Y | 本课短语 | | | ||
23 | + | student | boolean | Y | 是否有学生版 true 有| | | ||
24 | + | teacher | boolean | Y | 是否有老师版 true 有 | | | ||
25 | + | ||
26 | + ``` | ||
27 | + { | ||
28 | + "key_knowledge": [ | ||
29 | + "that引导的宾语从句_that省略" | ||
30 | + ], | ||
31 | + "words": [ | ||
32 | + "reason", | ||
33 | + "year", | ||
34 | + "about" | ||
35 | + ], | ||
36 | + "phrases": [], | ||
37 | + "student": true, | ||
38 | + "teacher": true | ||
39 | +} | ||
40 | +``` | ||
41 | + | ||
42 | + | ||
43 | + | ||
44 | + |
-
Please register or login to post a comment