API接口定义

学院

添加学院

基本信息

Path: /api/v1/college/new

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
namestring非必须学院名称,将会模糊搜索

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

获取学院

基本信息

Path: /api/v1/college/list

Method: POST

接口描述: 获取学院,可以根据关键字模糊查询

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
namestring非必须学院名称,将会模糊搜索

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

课程

开课

基本信息

Path: /api/v1/course/open

Method: POST

接口描述: 添加新课头

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
courseCommonIdinteger必须课程id
courseSchedulesobject []非必须上课时间

item 类型: object

├─ dayOfWeekinteger非必须每周第几天

最大值: 6

最小值: 0

枚举: 0,1,2,3,4,5,6

├─ endHoursIdinteger必须第几节课结束(包含该节课)

最大值: 24

最小值: 1

├─ endWeekIdinteger必须结束周次

最小值: 1

├─ startHoursIdinteger必须第几节课开始(包含该节课)

最大值: 24

最小值: 1

├─ startWeekIdinteger必须起始周次

最小值: 1

locationstring必须上课地点
quotainteger必须容量
semesterIdinteger必须学期id
teacherIdinteger必须教师id

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

撤课

基本信息

Path: /api/v1/course/select

Method: DELETE

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
courseIdinteger必须课头id
studentIdinteger非必须学生id,用于指定为谁选课和撤课(但是仅管理员可为他人选撤课仅管理员)

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

更新课头

基本信息

Path: /api/v1/course/spec/{id}

Method: PUT

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
路径参数
参数名称示例备注
id课头ID
Body
名称类型是否必须默认值备注其他信息
courseSchedulesobject []非必须上课时间

item 类型: object

├─ dayOfWeekinteger非必须每周第几天

最大值: 6

最小值: 0

枚举: 0,1,2,3,4,5,6

├─ endHoursIdinteger必须第几节课结束(包含该节课)

最大值: 24

最小值: 1

├─ endWeekIdinteger必须结束周次

最小值: 1

├─ startHoursIdinteger必须第几节课开始(包含该节课)

最大值: 24

最小值: 1

├─ startWeekIdinteger必须起始周次

最小值: 1

locationstring必须上课地点
quotainteger必须容量
teacherIdinteger必须教师id

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

更新课程

基本信息

Path: /api/v1/course/{id}

Method: PUT

接口描述: 更新课程的公共信息

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
路径参数
参数名称示例备注
id课程ID
Body
名称类型是否必须默认值备注其他信息
collegeIdinteger必须学院id
creditsnumber必须学分
hoursinteger必须学时
namestring必须课程名称

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

查询课头详细信息

基本信息

Path: /api/v1/course/spec/{id}

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
路径参数
参数名称示例备注
id课头ID

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

查询课程安排

基本信息

Path: /api/v1/course/schedules

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
semesterIdsinteger []必须学期id为空则获取所有学期的课程安排

item 类型: integer

├─非必须
userIdinteger非必须用户id。可以为教师、学生,为空时获取当前登录用户的

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

添加课程

基本信息

Path: /api/v1/course

Method: POST

接口描述: 添加新课程

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
collegeIdinteger必须学院id
creditsnumber必须学分
hoursinteger必须学时
namestring必须课程名称

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

获取课程列表

基本信息

Path: /api/v1/course/list

Method: POST

接口描述: 可根据课程名关键字、学期、教师名字、学院ID筛选,字符串类参数为模糊搜索,填空代表不筛选对应条件

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
collegesIdinteger []非必须包含的学院id

item 类型: integer

├─非必须
namestring非必须课程名称
onlyLeftQuotaboolean非必须仅有余量
pageinteger非必须当前页
semesterinteger非必须学期id
sizeinteger非必须每页大小
teacherNamestring非必须教师名称

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

选课

基本信息

Path: /api/v1/course/select

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
courseIdinteger必须课头id
studentIdinteger非必须学生id,用于指定为谁选课和撤课(但是仅管理员可为他人选撤课仅管理员)

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

初始化

初始化系统

基本信息

Path: /api/v1/init

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
idinteger必须管理员ID
passwordstring必须管理员密码
realNamestring必须管理员真实姓名

最大长度: 10

最小长度: 2

usernamestring必须管理员用户名

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

检测是否已初始化系统

基本信息

Path: /api/v1/init

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

公共

可否注册

基本信息

Path: /api/v1/register/enable

Method: GET

接口描述: 检测是否注册

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

开放注册

基本信息

Path: /api/v1/register/enable

Method: POST

接口描述: 开放注册

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
enableboolean非必须

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

注册

基本信息

Path: /api/v1/register

Method: POST

接口描述: 注册

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
collegeIdinteger必须
idinteger非必须
passwordstring必须
realNamestring必须

最大长度: 10

最小长度: 1

usernamestring必须

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

登出

基本信息

Path: /api/v1/logout

Method: GET

接口描述: 登出

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

登录

基本信息

Path: /api/v1/login

Method: POST

接口描述: 登录

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
passwordstring必须
usernamestring必须

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

学期

创建学期

基本信息

Path: /api/v1/semester

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
terminteger必须对应年份第几学期

最大值: 4

最小值: 1

yearinteger必须年份

最小值: 1980

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

获取学期

基本信息

Path: /api/v1/semester

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

获取当前学期

基本信息

Path: /api/v1/semester/curr

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

设置当前学期

基本信息

Path: /api/v1/semester/curr

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
idinteger必须

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

用户

删除指定用户

基本信息

Path: /api/v1/user/{id}

Method: DELETE

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
路径参数
参数名称示例备注
id用户id

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

更新任意用户信息

基本信息

Path: /api/v1/user/{id}

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
路径参数
参数名称示例备注
id用户id
Body
名称类型是否必须默认值备注其他信息
collegeIdinteger必须学院id

最小值: 1

entranceYearinteger必须入学/入职年份

最小值: 1980

realNamestring必须真实姓名

最大长度: 10

最小长度: 1

roleinteger非必须角色
usernamestring必须用户名

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

更新用户信息

基本信息

Path: /api/v1/user

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
collegeIdinteger必须学院id

最小值: 1

entranceYearinteger必须入学/入职年份

最小值: 1980

realNamestring必须真实姓名

最大长度: 10

最小长度: 1

roleinteger非必须角色
usernamestring必须用户名

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

更新用户密码

基本信息

Path: /api/v1/user/pwd

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
路径参数
参数名称示例备注
id用户id
Body
名称类型是否必须默认值备注其他信息
passwordstring必须

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

更新用户密码

基本信息

Path: /api/v1/user/{id}/pwd

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
路径参数
参数名称示例备注
id用户id
Body
名称类型是否必须默认值备注其他信息
passwordstring必须

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

添加用户

基本信息

Path: /api/v1/user/new

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
collegeIdinteger必须学院id
entranceYearinteger必须入学/入职年份

最小值: 1980

idinteger必须用户id
passwordstring必须密码
realNamestring必须真实姓名

最大长度: 10

最小长度: 1

roleinteger非必须角色
usernamestring必须用户名

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

获取任意用户信息

基本信息

Path: /api/v1/user/{id}

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
路径参数
参数名称示例备注
id用户id

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

获取当前登录用户信息

基本信息

Path: /api/v1/user

Method: GET

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须

获取用户列表

基本信息

Path: /api/v1/user/list

Method: POST

接口描述:

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json
Body
名称类型是否必须默认值备注其他信息
collegesIdinteger []非必须

item 类型: integer

├─非必须
entranceYearFrominteger非必须
entranceYearTointeger非必须
idinteger非必须
pageinteger非必须当前页
realNamestring非必须
rolesinteger []非必须

item 类型: integer

├─非必须角色
sizeinteger非必须每页大小
usernamestring非必须

返回数据

名称类型是否必须默认值备注其他信息
codeinteger非必须
databoolean非必须
msgstring非必须
Last Updated:
Contributors: SalHe