huayandong / recommend-api

新版本一对一 后台接口

1. 候选学生列表查询接口

• URL: {{localhost}}/boxfish-online-card/classOnline/manage/getCandidateStudent
• Method: POST
• RequestBody:

{
    "pageId": 0,
    "pageSize": 20,
    "studentId": 100000006030,
    "orderStatus": "ORDER_SCHEDULE_ALL",
    "startTime": null,
    "endTime": null
}

1. orderStatus为枚举值，枚举量为：
   ORDER_SCHEDULE_ALL, // 全部订单
   ORDER_SCHEDULE_UN_OPEN, // 未开课订单
   ORDER_SCHEDULE_OPENED, // 已开课订单
   ORDER_SCHEDULE_OVER; // 已完成订单
   

默认值查全部：orderStatus = ORDER_SCHEDULE_ALL

1. 学生ID、订单状态、时间范围为多条件查询

2. 创建班级，创建课表接口

• URL: {{localhost}}/boxfish-online-card/classOnline/manage/createStudentSchedule
• Method: POST
• RequestBody:

{
    "operationAccount": "xxx@b.cb",
    "classSmallOrderId": 326,
    "grade": "GRADE_2_B",
    "classOpenTime": 1560528000000,
    "scheduleList": [
        {
            "weekend": "MONDAY",
            "timeSlice": "S1000"
        },
        {
            "weekend": "THURSDAY",
            "timeSlice": "S2130"
        }
    ]
}

3. 一对一班级列表接口查询

• URL: {{localhost}}/boxfish-online-card/classSmall/manager/queryClass
• Method: POST
• RequestBody:

{
    "name": "326-测试班课",
    "mentorName": "测试mentor",
    "flagEnable": true,           // 班级是否开放
    "flagTeacherChinese": false,  // 是否安排中教
    "flagTeacherEnglish": false,  // 是否安排外教
    "flagSchedule": true,         // 是否安排课表
    "flagClassClosed": false,     // 课程是否结束
    "groupType": "GROUP_CLASS_ONLINE_0101"
}

该接口还是小班课班级列表查询接口，原来接口多条件查询参数不变， 只是这个接口在原来的接口基础上增加参数groupType，参数值为GROUP_CLASS_ONLINE_0101

4. 课程冻结接口

• URL: {{localhost}}/boxfish-online-card/classOnline/manage/frozenStudentSchedule
• Method: POST
• RequestBody:

{
    "operationAccount": "xxx@b.cn",
    "scheduleClassId": "CIDCOU_0101-60F14CDF763542B88D1EF8797AE12851",
    "flagFrozenSchedule": true
}

5. 候选学生列表，冻结接口

• URL: {{localhost}}/boxfish-online-card/classOnline/manage/editCandidateStudentOrder
• Method: POST
• RequestBody:

{
    "operationAccount": "xxx@b.cn",
    "flagEnable": false,

    "studentId": 100000006030,
    "orderCode": "xxx_orderCode",
    "classType": "CLASS_ONLINE_US_0101"
}

参数classType为固定值，classType = CLASS_ONLINE_US_0101

6. 查询学生已创建一对一课程订单接口

• URL: {{localhost}}/boxfish-online-card/classOnline/manage/getUserCandidateOrderCode
• Method: POST
• RequestBody:

{
    "studentId":100000006030
}

7. 一对一课表查询

• URL: {{localhost}}/boxfish-online-card/classOnline/manager/queryStudentSchedule
• Method: POST
• RequestBody:

{
    "studentId": 100000006030,
    "orderCode": "PGBYZCOR-DEMOV207B-SINGTON",
    "startTime": 1558949028000,
    "endTime": 1561627428000
}

返回体结构

public static class ScheduleDetail {
    private Long classSmallInfoId;      // 小班课ID

    private Long classSmallScheduleId;  // 课表ID
    private String classId;
    private ClassType classType;
    private Preference.Grade grade;
    private String gradeDesc;

    private String courseId;
    private String courseProjectName;
    private String courseNameChinese;
    private String courseNameEnglish;

    private Long teacherId;
    private String teacherName;

    private DateTime startTime;
    private DateTime endTime;
    private DateTime deadTime;

    private String orderCode;
    private String packageCode;

    private Boolean flagFrozen;     // 课程是否冻结
}

8. 添加 一对一课程信息

• URL: {{localhost}}/boxfish-online-card/classOnline/manage/addClassOnlineSchedule
• Method: POST
• RequestBody:

{
    "operationAccount": "xxx@b.cn",
    "classSmallInfoId": 46,
    "scheduleStartTimes": [
        {
            "scheduleDate": "2019-06-26",
            "timeSlice": "S1930"
        },
        {
            "scheduleDate": "2019-06-27",
            "timeSlice": "S1930"
        }
    ]
}

9. 检查课表群组是否存在

• URL: {{localhost}}/boxfish-online-card/classOnline/manage/checkScheduleGroup
• Method: POST
• RequestBody:

{
   "scheduleClassId": "CIDLUA-BE408AE7C39443C9AE8269B0E97B0339"
}