huayandong

update doc api

... ... @@ -15,7 +15,6 @@ access_token | String | Y | 接口请求凭证
- ResponseBody:
变量名 | 类型 | 说明
--- | --- | :---
status | String | 接口请求状态标识:`status = SUCCESS`请求成功,`status = ERROR`请求失败
... ... @@ -114,10 +113,38 @@ paperName | `Array.<String>` | 当前书中全部课程的名称,服务器已
- Method: GET
- RequestParam:
> 参数:班级ID: `bookId`
请求参数 | 类型 | 必填 | 说明
--- | --- | --- | :---
access_token | String | Y | 接口请求凭证
bookId | Integer | Y | 书的id
- ResponseBody:
变量名 | 类型 | 说明
--- | --- | :---
status | String | 接口请求状态标识:`status = SUCCESS`请求成功,`status = ERROR`请求失败
message | String | `status = ERROR`时的异常描述信息,`status = SUCCESS`时该字段为空
courseList | `Array.<Object>` | 课程信息
- [x] `courseList`的结构
变量名 | 类型 | 说明
--- | --- | :---
paperId | String | 课程的纸质课程ID,`如果该课程是不是真的三件套课程,则该字段为空`
courseId | String | 该课程APP课程的ID,不管是真三件套还是假三件套,该字段一定不为空
name | String | 课程名称
cover | String | 课程封面,MD5值
orderIndex | Integer | 课程的排序顺序
student | boolean | 该课程是否有学生版
teacher | boolean | 该课程是否有老师版
is_paper | boolean | 该是否为真三件套,`is_paper = true`课程是真三件套,`is_paper = false`课程是假三件套
paperType | String | 课程的类型,可能有的值为:`WORD``KNOWLEDGE``READING`
nationalKnowledge | `Array.<String>` | 课程的教材大纲知识点
- [x] 返回数据示例
```json
{
"status": "SUCCESS",
... ...