all-project/docs/开发文档/API/班级信息管理API.md

班级信息管理API文档

基本信息

• 模块名称: 班级信息管理
• 接口前缀: /classMsg
• 权限前缀: classMsg:classMsg:

API接口列表

1. 班级信息查询接口

1.1 获取班级信息列表

• 接口URL: /classMsg/classMsg/list
• 请求方式: GET
• 权限标识: classMsg:classMsg:list
• 请求参数:

参数名	类型	是否必须	描述
pageNum	int	是	页码
pageSize	int	是	每页条数
collegeId	int	否	学院ID
majorId	int	否	专业ID
className	string	否	班级名称
classType	int	否	班级类型
grade	string	否	年级
classStatus	int	否	班级状态

• 返回参数:

{
  "code": 200,
  "msg": "操作成功",
  "rows": [
    {
      "id": 1,
      "collegeId": 1001,
      "collegeName": "信息学院",
      "majorId": 2001,
      "majorName": "计算机科学与技术",
      "classCode": "CS2025-01",
      "className": "计科2025-01班",
      "classType": 1,
      "grade": "2025",
      "enrollmentYear": 2025,
      "graduationYear": 2029,
      "counselorId": 102,
      "counselorName": "李老师",
      "classTeacherId": 103,
      "classTeacherName": "张老师",
      "classStatus": 1,
      "remark": "示例班级"
    }
  ],
  "total": 1
}

1.2 获取班级信息详情

• 接口URL: /classMsg/classMsg/{id}
• 请求方式: GET
• 权限标识: classMsg:classMsg:query
• 请求参数:

参数名	类型	是否必须	描述
id	int	是	班级ID

• 返回参数:

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "id": 1,
    "collegeId": 1001,
    "collegeName": "信息学院",
    "majorId": 2001,
    "majorName": "计算机科学与技术",
    "classCode": "CS2025-01",
    "className": "计科2025-01班",
    "classType": 1,
    "grade": "2025",
    "enrollmentYear": 2025,
    "graduationYear": 2029,
    "counselorId": 102,
    "counselorName": "李老师",
    "classTeacherId": 103,
    "classTeacherName": "张老师",
    "classStatus": 1,
    "remark": "示例班级"
  }
}

1.3 获取当前登录人作为班主任的班级列表

• 接口URL: /classMsg/classMsg/myClassListAsTeacher
• 请求方式: GET
• 权限标识: classMsg:classMsg:list
• 请求参数: 无
• 返回参数:

{
  "code": 200,
  "msg": "操作成功",
  "data": [
    {
      "id": 1,
      "className": "计科2025-01班",
      "majorId": 2001,
      "majorName": "计算机科学与技术",
      "grade": "2025",
      "classStatus": 1
    }
  ]
}

2. 班级信息维护接口

2.1 新增班级信息

• 接口URL: /classMsg/classMsg
• 请求方式: POST
• 权限标识: classMsg:classMsg:add
• 请求参数:

{
  "collegeId": 1001,
  "collegeName": "信息学院",
  "majorId": 2001,
  "majorName": "计算机科学与技术",
  "classCode": "CS2025-01",
  "className": "计科2025-01班",
  "classType": 1,
  "grade": "2025",
  "enrollmentYear": 2025,
  "graduationYear": 2029,
  "classStatus": 1,
  "remark": "示例班级"
}

• 返回参数:

{
  "code": 200,
  "msg": "操作成功"
}

2.2 修改班级信息

• 接口URL: /classMsg/classMsg
• 请求方式: PUT
• 权限标识: classMsg:classMsg:edit
• 请求参数:

{
  "id": 1,
  "collegeId": 1001,
  "collegeName": "信息学院",
  "majorId": 2001,
  "majorName": "计算机科学与技术",
  "classCode": "CS2025-01",
  "className": "计科2025-01班",
  "classType": 1,
  "grade": "2025",
  "enrollmentYear": 2025,
  "graduationYear": 2029,
  "classStatus": 1,
  "remark": "修改后的班级"
}

• 返回参数:

{
  "code": 200,
  "msg": "操作成功"
}

2.3 设置班主任

• 接口URL: /classMsg/classMsg
• 请求方式: PUT
• 权限标识: classMsg:classMsg:edit
• 请求参数:

{
  "id": 1,
  "classTeacherId": 103,
  "classTeacherName": "张老师"
}

• 返回参数:

{
  "code": 200,
  "msg": "操作成功"
}

2.4 设置辅导员

• 接口URL: /classMsg/classMsg
• 请求方式: PUT
• 权限标识: classMsg:classMsg:edit
• 请求参数:

{
  "id": 1,
  "counselorId": 102,
  "counselorName": "李老师"
}

• 返回参数:

{
  "code": 200,
  "msg": "操作成功"
}

2.5 删除班级信息

• 接口URL: /classMsg/classMsg/{ids}
• 请求方式: DELETE
• 权限标识: classMsg:classMsg:remove
• 请求参数:

参数名	类型	是否必须	描述
ids	string	是	班级ID，多个用逗号分隔

• 返回参数:

{
  "code": 200,
  "msg": "操作成功"
}

2.6 导出班级信息

• 接口URL: /classMsg/classMsg/export
• 请求方式: GET
• 权限标识: classMsg:classMsg:export
• 请求参数: 与查询参数相同
• 返回参数: 文件流

3. 班级教师关联接口

3.1 查询有效用户列表(用于班主任/辅导员选择)

• 接口URL: /xg/sysUser/activeList
• 请求方式: GET
• 权限标识: xg:sysUser:list
• 请求参数: 无
• 返回参数:

{
  "code": 200,
  "msg": "操作成功",
  "data": [
    {
      "userId": 100,
      "userName": "teacher1",
      "nickName": "张老师",
      "email": "zhang@example.com",
      "phonenumber": "13800138000",
      "sex": "0",
      "status": "0",
      "deptId": 101,
      "deptName": "计算机系"
    },
    {
      "userId": 101,
      "userName": "teacher2",
      "nickName": "李老师",
      "email": "li@example.com",
      "phonenumber": "13800138001",
      "sex": "1",
      "status": "0",
      "deptId": 102,
      "deptName": "机械系"
    }
  ]
}

数据字典

班级类型(classType)

编码	名称
1	中级工
2	高级工
3	预备技师
4	技师
5	中高职一体

班级状态(classStatus)

编码	名称
1	正常
2	暂停
3	毕业
4	解散

是否已毕业(isGraduation)

编码	名称
0	未毕业
1	已毕业