huayandong

update doc api

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