huayandong / recommend-api

Go to a project
Toggle navigation Toggle navigation pinning
Switch branch/tag
小班课后台接口.md 7.45 KB

996.icu

小班课后台接口文档

1. 创建班级
  • URL: {{localhost}}/boxfish-online-card/classSmall/manager/addClass
  • Method: POST
  • RequestBody:
{
    "operationAccount":"zhangwang@boxfish.cn",
    "name":"五年级下-4月班级BAKKK",
    "englishName":"GRADE_5_B Junly small calss",
    "grade":"GRADE_5_B",
    "mentorName":"张旺老师",
    "classOpenTime":1554134400000,
    "classCloseTime":1556640000000,
    "scheduleList":[
        {
            "classType":"CLASS_SMALL_CN",
            "weekend":"TUESDAY",
            "scheduleStartTime":1554199200000,
            "scheduleEndTime":1554200700000,
            "scheduleDeadTime":1554201000000
        },
        {
            "classType":"CLASS_SMALL_US",
            "weekend":"FRIDAY",
            "scheduleStartTime":1554204600000,
            "scheduleEndTime":1554206100000,
            "scheduleDeadTime":1554199200000
        }
    ]
}
  • ResponseBody:
{
    "status": "SUCCESS",
    "message": "添加课程成功"
}
2. 查询班级列表
  • URL: {{localhost}}/boxfish-online-card/classSmall/manager/queryClass
  • Method: POST
  • RequestBody:
private Integer pageId = 0;
private Integer pageSize = 40;

private String name;                // 小班课名称
private String mentorName;          // 班主任名称

private Boolean flagEnable;         // 是否开放：true查询开放班级，false查询关闭班级、null查询全部
private Boolean flagTeacherChinese; // 是否安排中教：true查询指定中教班级、false查询未指定中教班级、null查询全部班级
private Boolean flagTeacherEnglish; // 是否安排外教：true查询指定外教班级、false查询未指定外教班级、null查询全部班级

private Boolean flagSchedule;       // 是否安排课表：true查询安排课表班级、false查询未安排课表班级、null查询全部班级
private Boolean flagClassClosed;    // 是否已结课：true查询已结束的班级、false查询未结束的班级、null查询全部班级
  • ResponseBody:
{
    "totalCount": 6,
    "totalPage": 1,
    "list": [
        {
            "id": 10,
            "name": "课表测试",
            "englishName": "schedule test",
            "grade": "二年级下",
            "flagEnable": false,
            "startTime": 1551369600000,
            "endTime": 1561824000000,
            "mentorName": "老了老弟"
        },
        {
            "id": 9,
            "name": "五年级下-4月班级BAKKK",
            "englishName": "GRADE_5_B Junly small calss",
            "grade": "五年级下",
            "flagEnable": false,
            "startTime": 1554134400000,
            "endTime": 1556640000000,
            "mentorName": "张旺老师",
            "teacherId": 100,
            "teacherName": "张老师",
            "teacherIdForeign": 200,
            "teacherForeignName": "Mr.Tony"
        }
    ]
}
3. 编辑班级
  • URL: {{localhost}}/boxfish-online-card/classSmall/manager/editClass
  • Method: POST
  • RequestBody:
{
    "operationAccount":"zhangwang@boxfish.cn",
    "id":9,
    "name":"五年级下-4月班级BAKKK-UPDATE",
    "englishName":"DNF-0403",

    "mentorName":"盒子鱼班主任杨老师",
    "classOpenTime":1554048000000,
    "classCloseTime":1556639999000,

    "teacherId":"100",
    "teacherName":"张旺老师",
    "teacherForeign":"200",
    "teacherForeignName":"Mr.Tony",

    "manageCourse":"课程管理",
    "manageChineseTeacher":"中教管理",
    "manageEnglishTeacher":"外教管理"
}
  • ResponseBody:
4. 设置班级默认中教老师和外教老师
  • URL: {{localhost}}/boxfish-online-card/classSmall/manager/classSpecifyTeacher
  • Method: POST
  • RequestBody:
{
    "operationAccount":"zhangwang@boxfish.cn",
    "classSmallName":"五年级下-4月班级BAKKK",

    "teacherId":100,
    "teacherName":"张老师",

    "teacherForeign":"200",
    "teacherForeignName":"Mr.Tony"
}
5. 查询课表
  • URL: {{localhost}}/boxfish-online-card/classSmall/manager/querySchedule
  • Method: POST
  • RequestBody:
{
    "startTime":1554048000000,
    "endTime":1556640000000,
    "classSmallName":"五年级下-4月班级BAKKK"
}
  • Response:
6. 保存课表
  • URL: {{localhost}}/boxfish-online-card/classSmall/manager/addSchedule
  • Method: POST
  • RequestBody:
{
    "operationAccount":"zhangwang@boxfish.cn",
    "classSmallName": "五年级下-4月班级",
    "list": [
        {
            "id": 4,
            "classType": "CLASS_SMALL_US",
            "teacherId": 1298980,
            "teacherInfo": "{\"userId\":1298980,\"realName\":\"刘老师\",\"avatars\":\"http://avatars.boxfish.cn/user/-12/figure/1411532427.jpg\",\"picture\":\"http://avatars.boxfish.cn/user/-12/figure/1411532427.jpg\",\"country\":\"四中\",\"tagSummary\":[\"教育学顶级名校高材生\",\"深受学生喜爱的资深教师\"],\"tagEducation\":[\"加拿大多伦多大学教学心理学专业\"],\"tagJob\":[\"15年英语教学经验\",\"英语备课组长、教研组长\"],\"tagTrait\":[\"重视情景教学，教学生动活泼\"]}",
            "courseId": "L3NoYXJlL3N2bi_kurrmlZnlhavlubTnuqfkuIogVW5pdDcvMDA0LTEu6auY57qn5ZCs6K-777ya55Om5Yqb55qE55Sf5rS7Lnhsc3g",
            "courseNameChinese": "高级听读：瓦力的生活",
            "courseNameEnglish": "",
            "courseProjectName": "/share/svn/人教八年级上 Unit7/004-1.高级听读：瓦力的生活.xlsx",
            "startTime": 1554121800000,
            "endTime": 1554123300000,
            "deadTime": 1554123600000
        },
        {
            "id": 5,
            "classType": "CLASS_SMALL_US",
            "teacherId": 1298980,
            "teacherInfo": "{\"userId\":1298980,\"realName\":\"刘老师\",\"avatars\":\"http://avatars.boxfish.cn/user/-12/figure/1411532427.jpg\",\"picture\":\"http://avatars.boxfish.cn/user/-12/figure/1411532427.jpg\",\"country\":\"四中\",\"tagSummary\":[\"教育学顶级名校高材生\",\"深受学生喜爱的资深教师\"],\"tagEducation\":[\"加拿大多伦多大学教学心理学专业\"],\"tagJob\":[\"15年英语教学经验\",\"英语备课组长、教研组长\"],\"tagTrait\":[\"重视情景教学，教学生动活泼\"]}",
            "courseId": "L3NoYXJlL3N2bi_kurrmlZnlhavlubTnuqfkuIogVW5pdDcvMDA0LTEu6auY57qn5ZCs6K-777ya55Om5Yqb55qE55Sf5rS7Lnhsc3g",
            "courseNameChinese": "高级听读：瓦力的生活",
            "courseNameEnglish": "",
            "courseProjectName": "/share/svn/人教八年级上 Unit7/004-1.高级听读：瓦力的生活.xlsx",
            "startTime": 1554120000000,
            "endTime": 1554121500000,
            "deadTime": 1554121800000
        }
    ]
}
7. 删除课表
  • URL: {{localhost}}/boxfish-online-card/classSmall/manager/removeClassSchedule
  • Method: POST
  • RequestBody:
{
    "operationAccount":"zhangwang@boxfish.cn",
    "id":119
}
8. 小班课添加学生
  • URL: {{localhost}}/boxfish-online-card/classSmall/manager/addClassStudent
  • Method: POST
  • RequestBody:
{
    "operationAccount": "sss",
    "classSmallName": "BOXFiSH-测试班级0404",
    "idList": [
        27,
        28,
        34
    ]
}
9. 查询小班课上课学生
  • URL: {{localhost}}/boxfish-online-card/classSmall/manager/getScheduleStudentAmount
  • Method: POST
  • RequestBody:
{
    "classId": "CIDCSC-D1BC8165490847C58D8F423F8F875777"
}
  • ResponseBody:
{
    "amountClassSmall": 0,    // 应上课人数
    "amountClassSchedule": 0,  // 实际上课人数
    "amountEvaluationStudent": 0    // 评价GOOD的学生人数
}