huayandong

update doc api

... ... @@ -6,21 +6,31 @@
##### 1. 候选学生列表查询接口
- URL: {{localhost}}/boxfish-online-card/classSmall/manager/queryCandidateStudent
- URL: {{localhost}}/boxfish-online-card/classOnline/manage/getCandidateStudent
- Method: POST
- RequestBody:
```json5
{
"studentId": 100000008016,
"classTypeList": [
"CLASS_ONLINE_US_0101"
]
"pageId": 0,
"pageSize": 20,
"studentId": 100000006030,
"orderStatus": "ORDER_SCHEDULE_ALL",
"startTime": null,
"endTime": null
}
```
> 在这个接口中,`classTypeList`字段的参数值为固定写死的。
> 1. `orderStatus`为枚举值,枚举量为:<br>
> ORDER_SCHEDULE_ALL, // 全部订单 <br>
> ORDER_SCHEDULE_UN_OPEN, // 未开课订单 <br>
> ORDER_SCHEDULE_OPENED, // 已开课订单 <br>
> ORDER_SCHEDULE_OVER; // 已完成订单 <br>
> 2. 学生ID、订单状态、时间范围为多条件查询
##### 2. 创建班级,创建课表接口
... ...