chong

a

> env.url: `https`://api[api-online.test].boxfish.cn
>
> notes:
>
* `默认所有接口都要携带token` access_token
# 外教思维课程目标【小结】接口
* URL {env.url}/foreign/course/{lesson}/summary
* GET Method
* path 参数:
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| lesson | String | Y |课程id| |
* response:
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| national_knowledge | List | N |大纲知识点| |
| international_knowledge | List | N |国际知识点| |
| words | List | N |单词| |
| phrases | List | N |短句| |
| sentences | List | N |核心句子| |
| dialogs | List | N |核心句子| |
contents
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| value | String | Y |内容| |
| definition | String | N |翻译| |
| actor | String | N |头像| |
dialogs 对话
头像的取法沿用课程内对话模版的取法,当 actors 字段不为空时,从actors 取到对应图片的 md5 使用 api.boxfish.cn/data/{md5} 获取对应的头像图片,当actors为空时,使用app内静态资源显示。
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| name | String | Y |显示的名字| |
| type | String | Y |类型| |
| actors | List | N |头像列表| |
| contents | List | N |对话内容| |
contents
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| actor | String | N |头像| |
| value | String | Y |内容| |
| definition | String | N |翻译| |
```json
{
"national_knowledge": [
"stop to do sth.",
"动词短语"
],
"international_knowledge": [
"人际交往-禁止"
],
"dialogs": [{
"name": "图片场景对话",
"type": "image_short_dialog",
"contents": [{
"actor": "woman",
"value": "The teacher stopped to stare at the naughty kid.",
"definition": "老师停了下来,看着那个淘气的孩子。"
},
{
"actor": "man",
"value": "I bet he is in trouble.",
"definition": "我敢打赌他有麻烦了。"
}
]
},
{
"name": "视频场景对话",
"type": "video_short_dialog",
"actors": {
"Shrek": "b305dd409c63b92e0ebb8e304b344fe8",
"Fiona": "9775d775dabbe1a5d21061e1f8438f88"
},
"contents": [{
"actor": "Fiona",
"value": "It'll take that long? Shouldn't we stop to make camp?",
"definition": "要那么久吗?我们不应该停下来扎营吗?"
},
{
"actor": "Shrek",
"value": "No, that'll take longer.",
"definition": "不行,那样会更久。"
}
]
}
],
"words": [{
"value": "play",
"definition": "v.玩"
},
{
"value": "TV"
}
],
"phrases": [{
"value": "do well",
"definition": ""
}],
"sentences": [{
"value": "The cat is staring at a fish.",
"definition": "这只猫正盯着一条鱼。"
},
{
"value": "She is a naughty girl.",
"definition": "她是一个淘气的女孩。"
},
{
"value": "She is in trouble.",
"definition": "她有麻烦了。"
}
]
}
}```
# 用户成绩接口
* URL {env.url}/user/omnipotent/foreign/lesson/{lesson}/learning
* GET Method
* path 参数:
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| lesson | String | Y |课程id| |
* response:
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| user_id | Long | N |用户ID| |
| completion_grade | String | N |本课成绩| |
| national_knowledge | List | N |大纲知识点| |
| international_knowledge | List | N |国际知识点| |
| words | List | N |单词| |
| phrases | List | N |短句| |
| sentences | List | N |核心句子| |
| dialogs | List | N |核心句子| |
contents
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| value | String | Y |内容| |
| definition | String | N |翻译| |
| actor | String | N |头像| |
dialogs 对话
头像的取法沿用课程内对话模版的取法,当 actors 字段不为空时,从actors 取到对应图片的 md5 使用 api.boxfish.cn/data/{md5} 获取对应的头像图片,当actors为空时,使用app内静态资源显示。
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| name | String | Y |显示的名字| |
| type | String | Y |类型| |
| actors | List | N |头像列表| |
| contents | List | N |对话内容| |
contents
|参数名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| actor | String | N |头像| |
| value | String | Y |内容| |
| definition | String | N |翻译| |
```json
{
"national_knowledge": [
"stop to do sth.",
"动词短语"
],
"international_knowledge": [
"人际交往-禁止"
],
"dialogs": [{
"name": "图片场景对话",
"type": "image_short_dialog",
"contents": [{
"actor": "woman",
"value": "The teacher stopped to stare at the naughty kid.",
"definition": "老师停了下来,看着那个淘气的孩子。"
},
{
"actor": "man",
"value": "I bet he is in trouble.",
"definition": "我敢打赌他有麻烦了。"
}
]
},
{
"name": "视频场景对话",
"type": "video_short_dialog",
"actors": {
"Shrek": "b305dd409c63b92e0ebb8e304b344fe8",
"Fiona": "9775d775dabbe1a5d21061e1f8438f88"
},
"contents": [{
"actor": "Fiona",
"value": "It'll take that long? Shouldn't we stop to make camp?",
"definition": "要那么久吗?我们不应该停下来扎营吗?"
},
{
"actor": "Shrek",
"value": "No, that'll take longer.",
"definition": "不行,那样会更久。"
}
]
}
],
"words": [{
"value": "play",
"definition": "v.玩"
},
{
"value": "TV"
}
],
"phrases": [{
"value": "do well",
"definition": ""
}],
"sentences": [{
"value": "The cat is staring at a fish.",
"definition": "这只猫正盯着一条鱼。"
},
{
"value": "She is a naughty girl.",
"definition": "她是一个淘气的女孩。"
},
{
"value": "She is in trouble.",
"definition": "她有麻烦了。"
}
]
}
}```
\ No newline at end of file
... ...