班级管理
班级列表查询
基本信息
请求路径:/clazzs
请求方式:GET
接口描述:该接口用于班级列表数据的条件分页查询
请求参数
参数格式:queryString
参数说明:
参数名称
是否必须
示例
备注
name
否
黄埔一期
班级名称
begin
否
2023/1/1
范围匹配的开始时间(结课时间)
end
否
2023/5/1
范围匹配的结束时间(结课时间)
page
是
1
分页查询的页码,如果未指定,默认为1
pageSize
是
10
分页查询的每页记录数,如果未指定,默认为10
请求数据样例:
/clazzs?page=1&pageSize=5
/clazzs?name=java&page=1&pageSize=5
/clazzs?begin=2023-01-01&end=2023-06-30&page=1&pageSize=5
/clazzs?name=java&begin=2023-01-01&end=2023-06-30&page=1&pageSize=5
响应数据
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
其他信息
code
number
必须
响应码, 1 成功 , 0 失败
msg
string
非必须
提示信息
data
object
必须
返回的数据
|- total
number
必须
总记录数
|- rows
object []
必须
数据列表
item 类型: object
|- id
number
非必须
id
|- name
string
非必须
班级名称
|- room
string
非必须
班级教室
|- beginDate
string
非必须
开课时间
|- endDate
string
非必须
结课时间
|- masterId
number
非必须
班主任(员工ID)
|- masterName
string
非必须
班主任姓名(员工姓名)
|- createTime
string
非必须
创建时间
|- updateTime
string
非必须
更新时间
|- status
string
非必须
状态 (未开班、已开班、已结课)
响应数据样例:
删除班级
基本信息
请求路径:/clazzs/{id}
请求方式:DELETE
接口描述:该接口用于删除班级信息
请求参数
参数格式:路径参数
参数说明:
参数名
类型
示例
是否必须
备注
id
number
1
必须
班级的ID
请求参数样例:/clazzs/5
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
添加班级
基本信息
请求路径:/clazzs
请求方式:POST
接口描述:该接口用于添加班级信息
请求参数
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
name
string
必须
班级名称
room
string
必须
班级教室
beginDate
string
必须
开课时间
endDate
string
必须
结课时间
masterId
number
非必须
班主任
subject
number
必须
学科, 1:java, 2:前端, 3:大数据, 4:Python, 5:Go, 6:嵌入式
请求数据样例:
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
根据ID查询
基本信息
请求路径:/clazzs/{id}
请求方式:GET
接口描述:该接口用于根据主键ID查询班级的信息
请求参数
参数格式:路径参数
参数说明:
参数名
类型
是否必须
备注
id
number
必须
班级ID
请求参数样例:/clazzs/8
响应数据
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
code
number
必须
响应码, 1 成功 , 0 失败
msg
string
非必须
提示信息
data
object
必须
返回的数据
|- id
number
必须
id
|- name
string
必须
班级名称
|- room
string
必须
班级教室
|- beginDate
string
必须
开课时间
|- endDate
string
必须
结课时间
|- masterId
number
必须
班主任(员工ID)
|- subject
number
非必须
学科, 1:java, 2:前端, 3:大数据, 4:Python, 5:Go, 6:嵌入式
|- createTime
string
必须
创建时间
|- updateTime
string
必须
更新时间
响应数据样例:
修改班级
基本信息
请求路径:/clazzs
请求方式:PUT
接口描述:该接口用于修改班级的数据信息
请求参数
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
id
number
必须
id
name
string
必须
班级名称
room
string
必须
班级教室
beginDate
string
必须
开课时间
endDate
string
必须
结课时间
masterId
number
必须
班主任ID(员工ID)
subject
number
非必须
学科, 1:java, 2:前端, 3:大数据, 4:Python, 5:Go, 6:嵌入式
请求数据样例:
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
查询所有班级
基本信息
请求路径:/clazzs/list
请求方式:GET
接口描述:该接口用于查询所有班级信息
请求参数
无
响应数据
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
code
number
必须
响应码, 1 成功 , 0 失败
msg
string
非必须
提示信息
data
object[]
非必须
返回的数据
|- id
number
非必须
id
|- name
string
非必须
班级名称
|- room
string
非必须
班级教室
|- beginDate
string
非必须
开课时间
|- endDate
string
非必须
结课时间
|- masterId
number
非必须
班主任(员工ID)
|- subject
number
非必须
学科, 1:java, 2:前端, 3:大数据, 4:Python, 5:Go, 6:嵌入式
|- createTime
string
非必须
创建时间
|- updateTime
string
非必须
更新时间
响应数据样例:
学员管理
学员列表查询
基本信息
请求路径:/students
请求方式:GET
接口描述:该接口用于学员列表数据的条件分页查询
请求参数
参数格式:queryString
参数说明:
参数名称
是否必须
示例
备注
name
否
张三
学员姓名
degree
否
1
学历(1:初中,2:高中,3:大专,4:本科,5:硕士,6:博士)
clazzId
否
2
班级ID
page
是
1
分页查询的页码,如果未指定,默认为1
pageSize
是
10
分页查询的每页记录数,如果未指定,默认为10
请求数据样例:
/students?page=1&pageSize=5
/students?name=张&page=1&pageSize=5
/students?name=张°ree=1&clazzId=2&page=1&pageSize=5
响应数据
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
code
number
必须
响应码, 1 成功 , 0 失败
msg
string
非必须
提示信息
data
object
必须
返回的数据
|- total
number
必须
总记录数
|- rows
object []
必须
数据列表
|- id
number
非必须
id
|- name
string
非必须
姓名
|- no
string
非必须
学号
|- gender
number
非必须
性别(1: 男 , 2: 女)
|- phone
string
非必须
手机号
|- degree
number
非必须
学历(1:初中,2:高中,3:大专,4:本科,5:硕士,6:博士)
|- idCard
string
非必须
身份证号
|- isCollege
number
非必须
是否是院校学生 (1: 是, 0: 否)
|- address
string
非必须
联系地址
|- graduationDate
string
非必须
毕业时间
|- violationCount
number
非必须
违纪次数
|- violationScore
number
非必须
违纪扣分
|- clazzId
number
非必须
班级ID
|- clazzName
string
非必须
班级名称
|- createTime
string
非必须
创建时间
|- updateTime
string
非必须
更新时间
响应数据样例: