新版本一对一后台接口.md 3.43 KB

996.icu

新版本一对一 后台接口

1. 候选学生列表查询接口
  • URL: {{localhost}}/boxfish-online-card/classSmall/manager/queryCandidateStudent
  • Method: POST
  • RequestBody:
{
    "studentId": 100000008016,
    "classTypeList": [
        "CLASS_ONLINE_US_0101"
    ]
}

在这个接口中,classTypeList字段的参数值为固定写死的。

2. 创建班级,创建课表接口
  • URL: {{localhost}}/boxfish-online-card/classOnline/manage/createStudentSchedule
  • Method: POST
  • RequestBody:
{
    "operationAccount": "xxx@b.cb",
    "classSmallOrderId": 326,
    "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/editCandidateStudent
  • Method: POST
  • RequestBody:
{
    "operationAccount": "xxx@b.cn",
    "flagEnable": false,
    "classSmallOrderId": 326
}
6. 查询学生已创建一对一课程订单接口
  • URL: {{localhost}}/boxfish-online-card/classOnline/manage/getUserCandidateOrderCode
  • Method: POST
  • RequestBody:
{
    "operationAccount": "xxx@b.cn",
    "flagEnable": false,
    "classSmallOrderId": 326
}
7. 一对一课表查询
  • URL: {{localhost}}/boxfish-online-card/classOnline/manager/queryStudentSchedule
  • Method: POST
  • RequestBody:
{
    "studentId": 100000006030,
    "orderCode": "PGBYZCOR-DEMOV207B-SINGTON"
}

返回体结构

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;     // 课程是否冻结
}