huayandong / recommend-api

小班课后台接口文档

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:

{
    "pageId":0,
    "pageSize":40,
    "name":""
}

• 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:

{
    "id":9,
    "name":"五年级下-4月班级BAKKK-UPDATE",

    "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:

{
    "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:

{
    "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
        }
    ]
}