liuming / developer-docs

Go to a project
Toggle navigation Toggle navigation pinning
chong
7dd66b39 1 parent 8af0fcd5

教师版接口

Inline Side-by-side
Showing 4 changed files with 399 additions and 0 deletions
> env.url: `https`://api[api-online.test].boxfish.cn
>
> notes:
>
* `默认所有接口都要携带token` access_token
# 用户课程学情接口
## 用户课程学情接口
* URL {env.url}/user/{userId}/lesson/{courseId}/learning
* GET Method
* path 参数:
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| userId | Long | Y | 学生id| 7566 |
| courseId | String | Y | app课程id| |
* request 参数:
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| paper | boolean | Y | 是否是纸质课程| |
* response：
* 课程未完成
| 变量名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| key_knowledge | List | Y | 核心知识点 | |
| words | List | Y | 本课单词 | |
| phrases | List | Y | 本课短语 | |
| course_finished | boolean | Y | 课程是否完成 | |
```
{
"key_knowledge": [
"天气weather: hot/cold/warm/cool"
],
"words": [
"be",
"like",
"cool"
],
"phrases": [],
"course_finished": false
}
```
* 课程完成一部分
| 变量名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| course_finished | boolean | Y | 课程是否完成 | |
| review_class | boolean | Y | 是否可以外教练习 | |
| paper_detail | Object | N | 纸质识别结果，参考纸质识别接口 | 待补充链接地址|
| course | List | N | 课程完成进度 | 待补充 |
```
{
"course_finished": true,
"review_class": true,
"paper_detail": {
"user_id": 100000007078,
"paperHasPart": true,
"paperHasWriting": false,
"summaryQuestionAmountAll": 7,
"summaryQuestionAmountCorrect": 7,
"summaryQuestionAmountWrong": 0,
"summaryQuestionRateCorrect": 1,
"summaryCompositionAdviceAmount": 0,
"questions": [{
"number": "1",
"correct": true
},
{
"number": "2",
"correct": true
},
{
"number": "3",
"correct": true
},
{
"number": "4",
"correct": true
},
{
"number": "5",
"correct": true
},
{
"number": "6",
"correct": true
},
{
"number": "7",
"correct": true
}
],
"partList": [],
"compositionAdviceList": [],
"imageUrls": [
"image/100000007078/20190111/1547187782.jpg",
"image/100000007078/20190111/1547187786.jpg"
],
"superviseVoiceAmount": 0
},
"course": [{
"id": "L3NoYXJlL3N2bi9MZXZlbCA0X0NvbnZlcnNhdGlvbjUvMDAxLuS9oOacieKAnOW8gOWtpuaBkOaDp-eXh-KAneWQl--8ny54bHN4",
"student": false,
"teacher": false,
"isAllUnFinished": false,
"course_type": "CONVERSATION",
"course_type_v2": "PROBLEM_SOLVING",
"review_class": true,
"national_knowledge": [
"a little bit",
"What happened?",
"what引导的特殊疑问句",
"个人生活-个人情感",
"表达情感-害怕"
],
"international_knowledge": [
"克服开学恐惧"
],
"paper_rage": 1,
"paper_id": "L3NoYXJlL3N2bi9MZXZlbCA0X0NvbnZlcnNhdGlvbjUvMDAxLuS9oOacieKAnOW8gOWtpuaBkOaDp-eXh-KAneWQl--8ny54bHN4",
"key_knowledge": "a little bit",
"is_paper": true,
"total_completion_grade": 2,
"paper_rate_score": 100
}]
}
```
... ...
> env.url: `https`://api[api-online.test].boxfish.cn
>
> notes:
>
* `默认所有接口都要携带token` access_token
# 老师便好设置相关接口
## 获取老师便好设置
* URL {env.url}/teacher/preference
* GET Method
* path 参数:
* request 参数:
* response：
| 变量名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| relation_material | String | Y |教材版本 | 北京版-五下 |
| difficulties | List | Y | 难度列表 | |
| fit_grade | String | Y | 用户真实年级 | |
| term | String | N | 学期 |[FIRST,SECOND] |
| grade_name | String | Y | 用户显示年级（转换 初一 等数据） | |
```
{
"relation_material": "北京版-五下",
"difficulties": [
"1",
"2",
"3",
"4"
],
"fit_grade": "五年级",
"term": "FIRST",
"grade_name": "五年级"
}
```
## 设置老师便好设置
* URL {env.url}/teacher/preference
* POST Method
* path 参数:
* request参数:
| 参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| relation_material | String | Y | 教材版本 | 北京版-五下 |
| difficulties | String | Y | 难度列表 | 1,2,3|
| fit_grade | String | Y | 用户选择年级 | |
| term | String | N | 学期 |[FIRST,SECOND] |
* response：
| 变量名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| relation_material | String | Y |教材版本 | 北京版-五下 |
| difficulties | List | Y | 难度列表 | |
| fit_grade | String | Y | 用户真实年级 | |
| term | String | N | 学期 |[FIRST,SECOND] |
| grade_name | String | Y | 用户显示年级（转换 初一 等数据） | |
```
{
"relation_material": "北京版-五下",
"difficulties": [
"1",
"2",
"3",
"4"
],
"fit_grade": "五年级",
"term": "FIRST",
"grade_name": "五年级"
}
```
... ...
> env.url: `https`://api[api-online.test].boxfish.cn
>
> notes:
>
* `默认所有接口都要携带token` access_token
# 新版书架相关接口
* URL {env.url}/teacher/textbook/unit/{catalogId}
* GET Method
* path 参数:
| 参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| catalogId | Long | Y |目录Id| 100129102 |
* request 参数:
| 参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| unit | String | Y |单元| 100129102 |
* response：
| 变量名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| contains_paper | boolean | Y |是否包含纸质版本 | 北京版-五下 |
| list | List | Y | 课程分类列表 | |
课程分类列表实体
| 变量名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| name | String | Y |分类名称 | 巧学重难点 |
| type | String | Y | 分类类型 | KNOWLEDGE |
| courses | List | Y | 课程列表| |
课程列表实体
| 变量名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| id | String | Y | 课程id| |
| name | String | Y | 课程名称 | |
| knowledge | String | Y |知识点 | |
| cover | String | Y |课程封面 | |
| level | String | Y |课程难度 | |
| lastModified | long | Y |课程最后修改时间 | |
| student | boolean | Y |是否有学生版 | |
| teacher | boolean | Y |是否有老师版 | |
| sequence | String | Y |课程排序（服务器用） | |
| free | String | Y |是否免费体验课程 true 是| |
| knowledge_type | String | Y |知识点类型| |
| course_type | String | Y |课程类型V1 | |
| course_type_v2 | String | Y |课程类型V2 | |
| review_class | boolean | Y |是否可以外教练习 | |
| course_type_group | String | Y |课程类型分组 | |
| is_paper | boolean | Y |是否是纸质课程 true 是 | |
| nationalKnowledge | List | N |大纲知识点 | |
| inrternationalKnowledge | List | N |国际知识点 | |
| knowledgeSystems | List | N |课程知识点标签（服务器用） | |
| basic_knowledge | boolean | Y |是否教材知识点课 | |
| basic_word | boolean | Y |是否是教材单词课 | |
```
{
"contains_paper": false,
"list": [{
"name": "巧学重难点",
"type": "KNOWLEDGE",
"courses": [{
"id": "L3NoYXJlL3N2bi9MZXZlbCA0X-WNleivjeeUqOazlTIvMDEzLuWNleivjeeUqOazlV9pbnZlbnQg5LiN5ZCM5b2i5byPLnhsc3g",
"name": "单词用法_invent 不同形式",
"knowledge": "invent/inventor/invention",
"cover": "adee031deb83be386dc730588c35fc8b",
"level": "4",
"lastModified": 1560751445986,
"student": true,
"teacher": true,
"sequence": 100,
"free": true,
"knowledge_type": "词汇组合与用法",
"course_type": "WORD",
"course_type_v2": "WORDS_EXPRESSIONS",
"review_class": true,
"course_type_group": "知识点",
"is_paper": false,
"nationalKnowledge": [
"invent/inventor/invention"
],
"basic_knowledge": true,
"basic_word": false
},
{
"id": "L3NoYXJlL3N2bi9MZXZlbCA0X0dyYW1tYXI0LzAwOC7lpoLkvZXooajovr7kuLvliqjlkozooqvliqjvvJ8ueGxzeA",
"name": "如何表达主动和被动？",
"knowledge": "被动语态",
"cover": "5cd63ba9aa1aed08b333a9d67a83fdc0",
"level": "4",
"lastModified": 1524917835829,
"student": true,
"teacher": true,
"sequence": 110,
"free": true,
"knowledge_type": "语法应用",
"course_type": "GRAMMAR",
"course_type_v2": "GRAMMAR_SENTENCES",
"review_class": true,
"course_type_group": "知识点",
"is_paper": false,
"nationalKnowledge": [
"被动语态be done"
],
"basic_knowledge": true,
"basic_word": false
},
{
"id": "L3NoYXJlL3N2bi9MZXZlbCA0X0Z1bmN0aW9uMTUvMDUwLiDlpoLkvZXooajovr7nlKjkvZzku4DkuYjvvJ8ueGxzeA",
"name": "如何表达用作什么？",
"knowledge": "be used for…",
"cover": "aa6ed92df59b1eec6f65a3327afe1262",
"level": "4",
"lastModified": 1560752502828,
"student": true,
"teacher": true,
"sequence": 90,
"free": false,
"knowledgeSystems": [{
"knowledgeSystemOne": "communication",
"knowledgeSystemTwo": "描述特征",
"knowledgeSystemThree": "功能"
}],
"knowledge_type": "功能对话",
"course_type": "FUNCTION",
"course_type_v2": "COMMUNICATION",
"review_class": true,
"course_type_group": "知识点",
"is_paper": false,
"internationalKnowledge": [
"描述特征-功能"
],
"nationalKnowledge": [
"be used for"
],
"basic_knowledge": true,
"basic_word": false
}
]
}]
}
```
\ No newline at end of file
... ...
> env.url: `https`://api[api-online.test].boxfish.cn
>
> notes:
>
* `默认所有接口都要携带token` access_token
## 课程包含学习内容接口
* URL {env.url}
* GET Method
* path 参数:
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| courseId | String | Y | app课程id| |
* request:
* response：
| 变量名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| key_knowledge | List | Y | 核心知识点 | |
| words | List | Y | 本课单词 | |
| phrases | List | Y | 本课短语 | |
| student | boolean | Y | 是否有学生版 true 有| |
| teacher | boolean | Y | 是否有老师版 true 有 | |
```
{
"key_knowledge": [
"that引导的宾语从句_that省略"
],
"words": [
"reason",
"year",
"about"
],
"phrases": [],
"student": true,
"teacher": true
}
```
... ...