huayandong

update doc api

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