huayandong

update doc api

... ... @@ -194,10 +194,6 @@ nationalKnowledge | `Array.<String>` | 课程的教材大纲知识点
```
> 接口1 和 接口2 在查询三件套课程列表的时候,需要用到老师偏好年级学期的这个字段信息,旧版本中教APP不支持这个字段,需要用最新开放版本中教APP才能使用。
##### 3. 【中教APP接口】中教老师APP 课程首页2页面 查询班级学生同步测验课程完成成绩
... ... @@ -205,6 +201,15 @@ nationalKnowledge | `Array.<String>` | 课程的教材大纲知识点
- Method: POST
- RequestBody:
- [x] 请求体结构
请求参数 | 类型 | 必填 | 说明
--- | --- | --- | :---
groupId | Integer | Y | 班级ID
paperId | String | Y | 纸质课程ID
- [x] 请求体数据示例
```json5
{
"groupId": 31213,
... ... @@ -212,9 +217,29 @@ nationalKnowledge | `Array.<String>` | 课程的教材大纲知识点
}
```
- ResponseBody:
- [x] 返回体结构
变量名 | 类型 | 说明
--- | --- | :---
status | String | 接口请求状态标识:`status = SUCCESS`请求成功,`status = ERROR`请求失败
message | String | `status = ERROR`时的异常描述信息,`status = SUCCESS`时该字段为空
grades | `Map.<String, Object>` | 每个等级成绩的学生情况,服务器已按照map的key排序,排序顺序为:`A_PLUS``A``B``C``D``UN_FINISHED`
- [x] `grades`的value的结构
变量名 | 类型 | 说明
--- | --- | :---
userId | Integer | 学生ID
userName | String | 学生名称,服务器优先显示:真实姓名、昵称、用户名,具体显示逻辑见产品文档,[中教产品文档:课程首页查看成绩-文档](https://gitlab.boxfish.cn/document/ProductDocs/uploads/7e6b29d4de256239502c7c9eaada3652/课程首页查看成绩-文档.png)
userAvatars | String | 学生头像,字符串类型,不是MD5
paperScore | Integer | 纸质课程识别的分数,为了方便服务器排序,<code color = 'yellow'>`UN_FINISHED`的学生服务器会设置`paperScore = -1`,APP端显示的时候需要注意这种情况 </code>
paperMark | String | 纸质课程成绩等级,根据纸质识别分数计算得到,计算规则见产品文档,[中教产品文档:课程首页2](https://gitlab.boxfish.cn/document/ProductDocs/uploads/7e6b29d4de256239502c7c9eaada3652/课程首页查看成绩-文档.png)
- [x] 返回体数据示例
```json5
{
"status": "SUCCESS",
... ...