Showing
1 changed file
with
165 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 | + * URL {env.url}/course/{lesson}/summary | ||
| 9 | + * GET Method | ||
| 10 | + * path 参数: | ||
| 11 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
| 12 | + |-------------|--------|------|----------|------| | ||
| 13 | + | lesson | String | Y |课程id| | | ||
| 14 | + | ||
| 15 | + | ||
| 16 | +* response: | ||
| 17 | + | ||
| 18 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
| 19 | + |-------------|--------|------|----------|------| | ||
| 20 | + | national_knowledge | List | N |大纲知识点| | | ||
| 21 | + | international_knowledge | List | N |国际知识点| | | ||
| 22 | + | words | List | N |单词| | | ||
| 23 | + | phrases | List | N |短句| | | ||
| 24 | +``` | ||
| 25 | + { | ||
| 26 | + "national_knowledge": [ | ||
| 27 | + "take a break", | ||
| 28 | + "肯定祈使句", | ||
| 29 | + "人际交往-职场生活" | ||
| 30 | + ], | ||
| 31 | + "international_knowledge": [ | ||
| 32 | + "人际交往-建议" | ||
| 33 | + ], | ||
| 34 | + "words": [ | ||
| 35 | + "but", | ||
| 36 | + "some", | ||
| 37 | + "be", | ||
| 38 | + "happy" | ||
| 39 | + ], | ||
| 40 | + "phrases": [ | ||
| 41 | + "come on", | ||
| 42 | + "have a rest" | ||
| 43 | + ] | ||
| 44 | + } | ||
| 45 | +``` | ||
| 46 | + | ||
| 47 | +# 全能思维课成绩查看接口 | ||
| 48 | + * URL {env.url}/user/lesson/{lesson}/learning | ||
| 49 | + * GET Method | ||
| 50 | + * path 参数: | ||
| 51 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
| 52 | + |-------------|--------|------|----------|------| | ||
| 53 | + | lesson | String | Y |课程id| | | ||
| 54 | + | ||
| 55 | + * request 参数: | ||
| 56 | + | ||
| 57 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
| 58 | + |-------------|--------|------|----------|------| | ||
| 59 | + | paper | boolean | Y |是否为纸质课程| | | ||
| 60 | + | ||
| 61 | + * response: | ||
| 62 | + | ||
| 63 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
| 64 | + |-------------|--------|------|----------|------| | ||
| 65 | + | course_finished | Boolean | Y |课程是否完成| | | ||
| 66 | + | review_class | Boolean | Y |课程是否完成| | | ||
| 67 | + | learning_words | List | Y |课程是否完成| learning_word | | learning_phrases | List | Y |课程是否完成| learning_phrase | | ||
| 68 | + | course | Object | Y |课程是否完成| | | ||
| 69 | + | ||
| 70 | + learning_word | ||
| 71 | + | ||
| 72 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
| 73 | + |-------------|--------|------|----------|------| | ||
| 74 | + | value | String | Y |内容| | | ||
| 75 | + | definition | String | Y | 定义| | | ||
| 76 | + | count | Int | Y |学习次数| | | ||
| 77 | + | star | Int | Y |评级| | | ||
| 78 | + | ||
| 79 | + learning_phrase | ||
| 80 | + | ||
| 81 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
| 82 | + |-------------|--------|------|----------|------| | ||
| 83 | + | value | String | Y |内容| | | ||
| 84 | + | definition | String | Y | 定义| | | ||
| 85 | + | count | Int | Y |学习次数| | | ||
| 86 | + | star | Int | Y |评级| | | ||
| 87 | + | ||
| 88 | + course | ||
| 89 | + | ||
| 90 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
| 91 | + |-------------|--------|------|----------|------| | ||
| 92 | + | id | String | Y |课程id| | | ||
| 93 | + | student | Boolean | Y | 是否有学生版| | | ||
| 94 | + | teacher | Boolean | Y |是否有老师版| | | ||
| 95 | + | finished | Boolean | Y |课程是否完成| | | ||
| 96 | + | isAllUnFinished | Boolean | Y |课程是否全部完成(app,纸质,外教练习)| | | ||
| 97 | + | course_type | String | Y | 课程类型| | | ||
| 98 | + | course_type_v2 | String | Y |课程类型V2| | | ||
| 99 | + | review_class | Boolean | Y |是否可以外教练习| | | ||
| 100 | + | national_knowledge | List | N | 大纲知识点| | | ||
| 101 | + | international_knowledge | String | N |国际知识点| | | ||
| 102 | + | paper_id | String | N |纸质课程id| | | ||
| 103 | + | is_paper | Boolean | Y |是否是纸质课程| | | ||
| 104 | + | completion_grade | Enum | N | 听说成绩| [A_PLUS,A,B,C,D] | | ||
| 105 | + | completion_grade_score |Int | N |听说成绩得分 | | | ||
| 106 | + | total_completion_grade |Double | N |五星成绩 | | | ||
| 107 | + | user_review_class |Object | N |外教练习结果 | | | ||
| 108 | + | paper_detail |Object | N |纸质识别结果 | | | ||
| 109 | + | ||
| 110 | +``` | ||
| 111 | + { | ||
| 112 | + "course_finished": true, | ||
| 113 | + "review_class": true, | ||
| 114 | + "learning_words": [{ | ||
| 115 | + "value": "i", | ||
| 116 | + "definition": "pron.我", | ||
| 117 | + "count": 4, | ||
| 118 | + "star": 2 | ||
| 119 | + }, | ||
| 120 | + { | ||
| 121 | + "value": "take", | ||
| 122 | + "definition": "v.买", | ||
| 123 | + "count": 4, | ||
| 124 | + "star": 2 | ||
| 125 | + }, | ||
| 126 | + { | ||
| 127 | + "value": "break", | ||
| 128 | + "definition": "n.休息", | ||
| 129 | + "count": 6, | ||
| 130 | + "star": 2 | ||
| 131 | + } | ||
| 132 | + ], | ||
| 133 | + "learning_phrases": [{ | ||
| 134 | + "value": "come on", | ||
| 135 | + "definition": "加油", | ||
| 136 | + "count": 2, | ||
| 137 | + "star": 1 | ||
| 138 | + }], | ||
| 139 | + "course": [{ | ||
| 140 | + "id": "L3NoYXJlL3N2bi9MZXZlbCAzX0Z1bmN0aW9uMTAvMDMyLuWmguS9leihqOi-vuKAnOS8keaBr-S4gOS4i-KAne-8ny54bHN4", | ||
| 141 | + "student": false, | ||
| 142 | + "teacher": false, | ||
| 143 | + "finished": true, | ||
| 144 | + "isAllUnFinished": false, | ||
| 145 | + "course_type": "FUNCTION", | ||
| 146 | + "course_type_v2": "COMMUNICATION", | ||
| 147 | + "review_class": true, | ||
| 148 | + "national_knowledge": [ | ||
| 149 | + "take a break", | ||
| 150 | + "肯定祈使句", | ||
| 151 | + "人际交往-职场生活" | ||
| 152 | + ], | ||
| 153 | + "international_knowledge": [ | ||
| 154 | + "人际交往-建议" | ||
| 155 | + ], | ||
| 156 | + "completion_grade": "B", | ||
| 157 | + "update_at": "2019-10-09T12:07:40.000", | ||
| 158 | + "paper_id": "L3NoYXJlL3N2bi9MZXZlbCAzX0Z1bmN0aW9uMTAvMDMyLuWmguS9leihqOi-vuKAnOS8keaBr-S4gOS4i-KAne-8ny54bHN4", | ||
| 159 | + "key_knowledge": "take a break", | ||
| 160 | + "is_paper": true, | ||
| 161 | + "completion_grade_score": 80, | ||
| 162 | + "total_completion_grade": 0.8 | ||
| 163 | + }] | ||
| 164 | + } | ||
| 165 | +``` |
-
Please register or login to post a comment