班级管理

获取班级列表

GET /school_management/homerooms

请求参数

参数名参数类型必填描述示例
searchstring搜索参数1班
statusstring按班级状态筛选班级active
status 参考值描述
active在校班级
graduated毕业班级

搜索参数

可搜索范围:

字段名描述
id班级ID
name班级名称

响应字段

字段名描述
id班级ID
name班级姓名
status班级状态
grade_id当前年级ID
grade_name年级名
student_count学生数量
teachers: id教师ID
teachers: name教师姓名

响应示例

成功响应:

Status: 200 OK
{
  "homerooms": [
    {
       "id": 56,
       "name": "一年(1)班",
       "status": "active",
       "grade_id": 965,
       "grade_name": "一年级",
       "student_count": "58",
       "teachers": [
         {
           "id": 15,
           "name": "王宇"
         },
         {
           "id": 17,
           "name": "李明"
         }
       ]
    }
  ]
}

获取班级

GET /school_management/homerooms/:id

请求参数

参数名参数类型必填描述示例
idinteger班级ID56

响应字段

字段名描述
id班级ID
name班级姓名
status班级状态
grade_id当前年级ID
grade_name年级名
student_count学生数量
teachers: id教师ID
teachers: name教师姓名

响应示例

成功响应:

Status: 200 OK
{
   "id": 56,
   "name": "一年(1)班",
   "status": "active",
   "grade_id": 965,
   "grade_name": "一年级",
   "student_count": "58",
   "teachers": [
     {
       "id": 15,
       "name": "王宇"
     },
     {
       "id": 17,
       "name": "李明"
     }
   ]
}

创建班级

POST /school_management/homerooms

请求参数

参数名参数类型必填描述示例
namestring班级名称五年(2)班
grade_idinteger年级ID8756

响应字段

字段名描述
id班级ID
name班级姓名
status班级状态
grade_id当前年级ID
grade_name年级名
student_count学生数量
teachers: id教师ID
teachers: name教师姓名

响应示例

成功响应:

Status: 201 Created
{
   "id": 56,
   "name": "一年(1)班",
   "status": "active",
   "grade_id": 965,
   "grade_name": "一年级",
   "student_count": "58",
   "teachers": [
     {
       "id": 15,
       "name": "王宇"
     },
     {
       "id": 17,
       "name": "李明"
     }
   ]
}

更新班级

PATCH /school_management/homerooms/:id

请求参数

参数名参数类型必填描述示例
idinteger班级ID56
namestring班级名称五年(2)班
grade_idinteger年级ID8756

响应字段

字段名描述
id班级ID
name班级姓名
status班级状态
grade_id当前年级ID
grade_name年级名
student_count学生数量
teachers: id教师ID
teachers: name教师姓名

响应示例

成功响应:

Status: 200 OK
{
   "id": 56,
   "name": "一年(1)班",
   "status": "active",
   "grade_id": 965,
   "grade_name": "一年级",
   "student_count": "58",
   "teachers": [
     {
       "id": 15,
       "name": "王宇"
     },
     {
       "id": 17,
       "name": "李明"
     }
   ]
}

删除班级

DELETE /school_management/homerooms/:id

请求参数

参数名参数类型必填描述示例
idinteger班级ID56

响应示例

成功响应:

Status: 204 No Content

失败响应:

Status: 422 Unprocessable Entity
{
  "error_code": 1010,
  "message": "无法删除有学生的班级"
}

设置为毕业班级

PATCH /school_management/homerooms/:id/graduate

请求参数

参数名参数类型必填描述示例
idinteger班级ID56

响应示例

成功响应:

Status: 200 OK

设置为在校班级

PATCH /school_management/homerooms/:id/ungraduate

请求参数

参数名参数类型必填描述示例
idinteger班级ID56

响应示例

成功响应:

Status: 200 OK

添加班主任

POST /school_management/homerooms/:id/teachers

请求参数

参数名参数类型必填描述示例
idinteger班级ID56
teacher_idinteger教师78

响应示例

成功响应:

Status: 201 Created

移除班主任

DELETE /school_management/homerooms/:id/teachers

请求参数

参数名参数类型必填描述示例
idinteger班级ID56
teacher_idinteger教师78

响应示例

成功响应:

Status: 204 No Content
Last Updated: 8/3/2018, 9:00:37 PM