docs / developer-docs

Go to a project
Toggle navigation Toggle navigation pinning
chong
a6c5d058 1 parent 71e7bbd8

班主任

Inline Side-by-side
Showing 1 changed file with 83 additions and 0 deletions
> env.url: `https`://api[api-online.test].boxfish.cn
>
> notes:
>
* `默认所有接口都要携带token` access_token
# 班主任接口
## 今日学情接口
* URL {env.url}/clazz/consultant/user/plan/learning
* GET Method
* path 参数:
* request 参数:
* response：
| 变量名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| unfinished | List | Y | 未完成学生列表 | |
| finished | List | Y | 已完成学生列表| |
* 学生列表：
| 变量名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| user_id | Long | Y | id | |
| user_real_name | String | Y |用户名字 |
| figure_url | String | Y | 头像| |
| courses | List | N | 已完成课程列表| |
| lesson | String | Y | 课程ID| |
| course_type_group_type | List | Y | 课程类型| |
| course_type_group_name | List | Y | 课程类型显示名| |
| completion_grade | List | Y | 成绩| |
```json
{
"unfinished": [{
"user_id": 9200,
"user_real_name": "吕寰",
"figure_url": "https://avatars.boxfish.cn/user/9200/figure/1516946382.jpg"
}],
"finished": [{
"user_id": 7566,
"user_real_name": "low",
"figure_url": "https://avatars.boxfish.cn/user/7566/figure/1563170627.jpg",
"courses": [{
"lesson": "L3NoYXJlL3N2bi9MZXZlbCAzX0Z1bmN0aW9uMS8wMjgu5aaC5L2V6K-i6Zeu5LuK5aSp5piv5ZGo5Yeg77yfLnhsc3g",
"course_type_group_type": "KNOWLEDGE",
"course_type_group_name": "AI知识点拓展课",
"completion_grade": "C"
},
{
"lesson": "L3NoYXJlL3N2bi9MZXZlbCAyX-WNleivjeeUqOazlTIvMjEyLuWNleivjeeUqOazlV93ZWVrIOaYn-acn-Wbm-WIsOaYn-acn-aXpS54bHN4",
"course_type_group_type": "KNOWLEDGE",
"course_type_group_name": "AI知识点拓展课",
"completion_grade": "A_PLUS"
}
]
}]
}
```
## 用户规划课程接口
* URL {env.url}/clazz/consultant/user/{userId}/plan/course
* GET Method
* path 参数:
| 变量名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| userId | Long | Y | 学生id| |
* request 参数:
* response：
| 变量名 | 类型 | 必填 | 说明 | 示例 |
|-------------|--------|------|----------|------|
| user_id | Long | Y | id | |
| user_real_name | String | Y | 用户名| |
| figure_url | String | Y | 用户名| |
| user_with_mobile | String | Y | 用户手机号| |
| plan_days | String | Y | 规划的时间| |
| plan_course_count_info | String | Y | 课程完成情况| |
| version | String | Y | 用户名| |
| user_plan_course | List | Y | 用户名| |
... ...