Files
hzdyjs/docs/开发文档/API/招生报名管理API.md
T
2025-07-24 21:03:00 +08:00

9.0 KiB
Raw Blame History

招生报名管理API文档

1. API 基本信息

  • 模块名称:招生报名管理
  • API 前缀:/zsjy/enrollment
  • 负责人:admin
  • 更新时间:2025-08-01

2. 通用返回格式

分页数据返回格式

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "total": 100,
    "rows": [
      // 数据列表
    ]
  }
}

普通数据返回格式

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    // 返回数据
  }
}

3. API 接口列表

3.1 获取招生报名列表(分页)

  • 请求方法:GET
  • 请求路径:/zsjy/enrollment/info/list
  • 接口描述:分页查询招生报名信息列表
  • 权限标识:zsjy:enrollment:info:list

请求参数

参数名称 参数类型 是否必须 描述
pageNum Integer 是 页码,从1开始
pageSize Integer 是 每页记录数
name String 否 姓名,支持模糊查询
idCard String 否 身份证号
gender String 否 性别(M-男 F-女)
examNumber String 否 准考证号
phone1 String 否 联系电话
examRegion String 否 中考地区
appliedMajor String 否 报考专业
collegeId String 否 学院代码
collegeName String 否 学院名称
enrollmentStatus String 否 报名状态(0-待审核 1-信息审核中 2-录取处理中 3-待最终确认 4-录取完成 9-已驳回)

响应参数

参数名称 参数类型 描述
id Long 主键ID
name String 姓名
idCard String 身份证号
gender String 性别(M-男 F-女)
phone1 String 联系电话
examNumber String 准考证号
examRegion String 中考地区
totalScore Integer 中考总分
appliedMajor String 报考专业
majorCode String 专业代码
collegeId String 学院代码
collegeName String 学院名称
enrollmentStatus String 报名状态
applicationTime Date 报名时间

3.2 获取招生报名详情

  • 请求方法:GET
  • 请求路径:/zsjy/enrollment/info/{id}
  • 接口描述:根据ID获取招生报名详情
  • 权限标识:zsjy:enrollment:info:query

请求参数

参数名称 参数类型 是否必须 描述
id Long 是 报名信息ID

响应参数

参数名称 参数类型 描述
id Long 主键ID
name String 姓名
idCard String 身份证号
gender String 性别(M-男 F-女)
isBoarding Integer 是否住校(0-否 1-是)
birthDate Date 出生年月
phone1 String 联系电话1
phone2 String 联系电话2
nation String 民族
homeAddress String 家庭地址
middleSchool String 初中毕业学校
examNumber String 准考证号
examRegion String 中考地区
totalScoreFull Integer 中考满分
totalScore Integer 中考总分
chineseScore BigDecimal 语文成绩
mathScore BigDecimal 数学成绩
englishScore BigDecimal 英语成绩
scienceScore BigDecimal 科学成绩
socialScore BigDecimal 社会成绩
peScore BigDecimal 体育成绩
appliedMajor String 报考专业
majorCode String 专业代码
collegeId String 学院代码
collegeName String 学院名称
uniformSize String 校服尺码
healthStatus String 健康状况
specialties String 特长
awards String 奖惩情况
enrollmentStatus String 报名状态
applicationTime Date 报名时间

3.3 新增招生报名信息

  • 请求方法:POST
  • 请求路径:/zsjy/enrollment/info
  • 接口描述:新增招生报名信息
  • 权限标识:zsjy:enrollment:info:add

请求参数

参数名称 参数类型 是否必须 描述
name String 是 姓名
idCard String 是 身份证号
gender String 是 性别(M-男 F-女)
isBoarding Integer 否 是否住校(0-否 1-是)
birthDate Date 否 出生年月
phone1 String 是 联系电话1
phone2 String 否 联系电话2
nation String 否 民族
homeAddress String 否 家庭地址
middleSchool String 否 初中毕业学校
examNumber String 否 准考证号
examRegion String 否 中考地区
totalScoreFull Integer 否 中考满分
totalScore Integer 否 中考总分
chineseScore BigDecimal 否 语文成绩
mathScore BigDecimal 否 数学成绩
englishScore BigDecimal 否 英语成绩
scienceScore BigDecimal 否 科学成绩
socialScore BigDecimal 否 社会成绩
peScore BigDecimal 否 体育成绩
appliedMajor String 是 报考专业
majorCode String 否 专业代码
collegeId String 否 学院代码
collegeName String 否 学院名称
uniformSize String 否 校服尺码
healthStatus String 否 健康状况
specialties String 否 特长
awards String 否 奖惩情况

响应参数

参数名称 参数类型 描述
code Integer 状态码,200表示成功
msg String 提示信息
data Boolean 操作结果,true表示成功

3.4 修改招生报名信息

  • 请求方法:PUT
  • 请求路径:/zsjy/enrollment/info
  • 接口描述:修改招生报名信息
  • 权限标识:zsjy:enrollment:info:edit

请求参数

参数名称 参数类型 是否必须 描述
id Long 是 主键ID
name String 是 姓名
idCard String 是 身份证号
gender String 是 性别(M-男 F-女)
isBoarding Integer 否 是否住校(0-否 1-是)
birthDate Date 否 出生年月
phone1 String 是 联系电话1
phone2 String 否 联系电话2
nation String 否 民族
homeAddress String 否 家庭地址
middleSchool String 否 初中毕业学校
examNumber String 否 准考证号
examRegion String 否 中考地区
totalScoreFull Integer 否 中考满分
totalScore Integer 否 中考总分
chineseScore BigDecimal 否 语文成绩
mathScore BigDecimal 否 数学成绩
englishScore BigDecimal 否 英语成绩
scienceScore BigDecimal 否 科学成绩
socialScore BigDecimal 否 社会成绩
peScore BigDecimal 否 体育成绩
appliedMajor String 是 报考专业
majorCode String 否 专业代码
collegeId String 否 学院代码
collegeName String 否 学院名称
uniformSize String 否 校服尺码
healthStatus String 否 健康状况
specialties String 否 特长
awards String 否 奖惩情况

响应参数

参数名称 参数类型 描述
code Integer 状态码,200表示成功
msg String 提示信息
data Boolean 操作结果,true表示成功

3.5 删除招生报名信息

  • 请求方法:DELETE
  • 请求路径:/zsjy/enrollment/info/{ids}
  • 接口描述:删除招生报名信息
  • 权限标识:zsjy:enrollment:info:remove

请求参数

参数名称 参数类型 是否必须 描述
ids Long[] 是 报名信息ID,多个ID以逗号分隔

响应参数

参数名称 参数类型 描述
code Integer 状态码,200表示成功
msg String 提示信息
data Boolean 操作结果,true表示成功

3.6 导出招生报名信息

  • 请求方法:POST
  • 请求路径:/zsjy/enrollment/info/export
  • 接口描述:导出招生报名信息
  • 权限标识:zsjy:enrollment:info:export

请求参数

与列表查询参数相同

响应参数

文件下载流

4. 数据字典

4.1 性别字典(zsjy_gender)

字典值 字典标签 备注
M 男 -
F 女 -

4.2 是否字典(sys_yes_no)

字典值 字典标签 备注
Y 是 -
N 否 -

4.3 报名状态字典(zsjy_enrollment_status)

字典值 字典标签 备注
0 待审核 -
1 信息审核中 -
2 录取处理中 -
3 待最终确认 -
4 录取完成 -
9 已驳回 -

4.4 学院字典(zsjy_college)

字典值 字典标签 备注
JDGC 机电工程学院 -
XXGC 信息工程学院 -
YSSJ 艺术设计学院 -
JJGL 经济管理学院 -
YYJK 医药健康学院 -