12 KiB
12 KiB
API文档总览
本文档提供心理咨询预约系统所有API接口的总览，便于开发人员快速查找和使用。
基础规范
请参考 API文档基础规范 了解通用的API调用规范、认证方式和响应格式。
API模块列表
- 学生信息管理API
- 学生信息收集批次管理API
- 学生信息收集批次API - 重要更新：修改列表排序方式为按创建时间倒序（2025-01-03）
- 班级信息管理API
- 班级干部信息管理API
- 宿舍管理API
- 宿舍房间管理API - 新增床位详细信息查询接口（2025-01-27）
- 宿舍床位分配管理API - 重要修复：床位分配不完整问题（2025-01-27）
- 宿舍申请管理API - 新增：支持学生调宿和退宿申请管理（2025-01-15）
- 宿舍管理员信息API
- 宿舍管理员授权API
- 学生管理员授权关系API
- 学生销假管理API
- 假期留宿管理API - 重要修复：单人留宿计算逻辑（2025-01-03）
- 均化处理最高分值API - 新增：支持考核申请均化处理功能（2025-01-03）
1. 用户认证登录
用户认证登录API - 包含用户登录、获取用户信息、修改密码等接口。
统一身份认证接入说明 - CAS OAuth2.0 统一认证登录完整流程、前后端协作与用户映射规则（2026-06-10 新增）。
2. 心理咨询预约
2.1 预约管理
心理咨询预约管理API - 包含预约时段管理、预约申请、预约处理等接口。
2.2 咨询师管理
心理咨询师管理API - 包含咨询师信息管理、排班管理等接口。
2.3 预约限制管理
预约限制功能API - 包含未到访记录管理、预约限制检查、限制解除等接口。
3. 心理健康测评
心理健康测评API - 包含测评问卷管理、测评结果分析等接口。
4. 统计报表
宿舍管理员信息API
- 宿舍管理员信息API：包含宿舍管理员信息的增删改查接口
- 支持不同类型宿舍管理员(全校管理员、自定义管理员、班主任)的管理
- 提供获取可用教职工信息的接口，支持选择教职工作为宿舍管理员
- 新增功能: 在添加管理员时，通过下拉选择可用教师，支持模糊搜索，并自动填充选中教师的手机号码和性别信息
核心功能:
- 宿舍管理员信息分页查询（支持多条件搜索）
- 宿舍管理员信息新增、修改、删除
- 宿舍管理员信息导出
- 获取可用教职工信息列表（排除已经成为指定类型管理员的人员）
- 教师选择下拉搜索组件，支持模糊搜索和自动填充数据
API基础路径: /xgStudentManager/studentManager
最新更新:
- 2025-07-25: 优化管理员添加界面，将姓名输入框改为可搜索的下拉选择框，选择后自动填充教师信息
- 2025-07-24: 完成宿舍管理员信息管理模块的API接口设计
- 2025-07-24: 添加获取可用的教职工信息列表接口，支持根据管理员类型筛选可用教职工
详细文档: 宿舍管理员信息API.md
企业信息管理API
企业信息管理API - 包含企业基本信息管理、招聘岗位管理（含子表CRUD）、招聘简章PDF生成（单个/批量）、Excel导入功能（支持企业+岗位一体化导入）。 重大更新（2026-03-30）：企业信息新增企业简介、办公电话、官网字段；整合岗位管理；新增简章PDF生成和导入功能。
统计报表API - 包含各类统计数据查询接口。
API接口汇总
| 接口名称 | 请求方法 | 接口路径 | 所属模块 | 权限标识 |
|---|---|---|---|---|
| 用户登录 | POST | /api/auth/login | 用户认证 | - |
| 获取用户信息 | GET | /api/auth/getInfo | 用户认证 | - |
| 获取可预约时段 | GET | /api/xljk/consultation/appointment/slots | 预约管理 | xljk:consultation:appointment:list |
| 提交预约申请 | POST | /api/xljk/consultation/appointment/apply | 预约管理 | xljk:consultation:appointment:apply |
| 处理预约申请 | POST | /api/xljk/consultation/appointment/process | 预约管理 | xljk:consultation:appointment:process |
| 获取房间床位详细信息 | GET | /dormbed/dormBed/details/room/{roomId} | 宿舍管理 | dormbed:dormBed:query |
| 获取宿舍楼床位详细信息 | GET | /dormbed/dormBed/details/building/{buildingId} | 宿舍管理 | dormbed:dormBed:query |
| 批量分配床位给班级 | POST | /dormBedStudent/dormBedStudent/batchAllocateToClass | 床位分配 | xgss:dormBedStudent:allocateToClass |
| 批量分配床位给学院 | POST | /dormBedStudent/dormBedStudent/batchAllocateToCollege | 床位分配 | xgss:dormBedStudent:allocateToCollege |
| 记录咨询结果 | POST | /api/xljk/consultation/appointment/record | 预约管理 | xljk:consultation:appointment:record |
| 查询未到访记录列表 | GET | /api/xljk/consultation/no-show/list | 预约限制 | xljk:consultation:noshow:list |
| 获取未到访记录详情 | GET | /api/xljk/consultation/no-show/{id} | 预约限制 | xljk:consultation:noshow:query |
| 解除预约限制 | PUT | /api/xljk/consultation/no-show/{id}/release | 预约限制 | xljk:consultation:noshow:release |
| 检查学生是否被限制预约 | GET | /api/xljk/consultation/no-show/check-limitation | 预约限制 | - |
更新历史
| 日期 | 版本 | 更新内容 | 更新人 |
|---|---|---|---|
| 2026-03-13 | 1.7 | 新增学生学籍异动与换班级API文档，补充复学+换班级事务化组合接口 | Cursor |
| 2025-12-26 | 1.6 | 新增专业信息管理API，支持树形菜单+列表的专业管理 | Cursor |
| 2025-12-26 | 1.5 | 新增二级学院管理API，支持二级学院的增删改查 | Cursor |
| 2025-01-03 | 1.1 | 社团管理API更新：删除副社长信息卡片，role_type字段改为字符串类型 | 系统管理员 |
| 2025-07-01 | 1.0 | 初始版本 | 系统管理员 |
| 2025-07-15 | 1.1 | 添加心理健康测评API | 张工 |
| 2025-07-30 | 1.2 | 添加预约限制功能API | Cursor |
| 2025-01-27 | 1.3 | 添加宿舍床位分配管理API，修复床位分配不完整问题 | Cursor |
| 2025-11-28 | 1.4 | 修复教师部门树接口排序兼容性，补充基础字段 | Cursor |
详细文档: 企业信息管理API.md
�� 最新更新日志
2025-01-27 - 新增班级学生查询接口
- 新增功能: 新增
GET /studentMsg/studentMsg/listByClassId接口 - 功能描述: 查询指定班级中所有在籍学生信息
- 过滤条件:
deleted = 0(未删除)student_status = '1'(在籍状态)class_id = 入参的classId(班级ID)name LIKE '%入参的name%'(姓名模糊查询，可选)
- 排序方式: 按学号降序排列
- 最新变更（2025-11-13）: 所有学生信息列表接口默认按学号降序排序，便于优先查看学号靠后的学生
- 权限要求:
studentMsg:studentMsg:query
2025-11-13 - 学生列表排序策略统一
- 心理健康测评:
GET /xljk/evaluation/detail/students/{classId}现在按学号降序返回班级学生，满足最新业务要求 - 学生考核奖励: 学生候选下拉接口默认按学号降序排列，保持后台与移动端行为一致
- 心理咨询预约: 预约记录列表接口默认按学号降序，随后按ID降序排序，并以创建时间倒序兜底保证顺序稳定
- 预约限制功能: 未到访记录分页默认先按学号降序，再按未到访日期、创建时间倒序
- 学生信息批次收集: 批次学生列表默认按学号降序，当学号一致时以创建时间倒序作为补充
2025-07-24 - 学生信息管理界面重构
- 界面重构: 学生信息管理新增弹窗调整为多tab页形式
- 功能增强: 新增照片上传功能，支持完整的学生信息录入
- 数据扩展: 支持60+个学生信息字段，包括：
- 基础信息: 学号、身份证号、姓名、性别、出生日期、民族、籍贯、政治面貌、照片等
- 扩展信息: 文化程度、户口类型、宗教信仰、生源地区、紧急联系人、特殊情况标记等
- 家庭信息: 父母信息、监护人信息、家庭经济状况等
- 健康信息: 身高、体重、血型、健康状况、疾病史、过敏史等
- 学籍信息: 录取类别、学籍状态、入学信息、专业班级、宿舍信息等
- 银行卡信息: 银行卡号、开户银行等
- 技术改进: 使用el-tabs组件管理多个表单页面，提升用户体验
2025-07-01 - API文档架构重构
- 重要重构: 将原本集中的大型API文档按业务模块拆分，提升维护效率
- 新增: API文档模板，用于新API文档的生成
- 优化: 目录结构，按功能模块分类管理
🔗 API文档导航
👨💼 人事管理模块
| API文档 | 描述 | 状态 | 更新时间 |
|---|---|---|---|
| 出国申请管理API | 出国申请审批流程管理（三级审批） | ✅ 完成 | 2025-01-28 |
| 出国登记管理API | 出国登记信息管理（已优化字段） | ✅ 完成 | 2025-09-30 |
👥 学工管理模块
| API文档 | 描述 | 状态 | 更新时间 |
|---|---|---|---|
| 学生信息收集批次管理API | 学生信息收集批次班级权限管理 | ✅ 完成 | 2025-01-27 |
| 学生信息批次收集API | 学生信息批次收集管理（新增） | ✅ 完成 | 2025-01-27 |
| 学生学籍异动与换班级API | 学籍异动与换班级（含复学+换班级事务接口） | ✅ 完成 | 2026-03-13 |
| 班级信息管理API | 班级基础信息增删改查 | ✅ 完成 | 2025-01-27 |
| 二级学院管理API | 二级学院组织信息管理 | ✅ 完成 | 2025-12-26 |
| 专业信息管理API | 专业信息管理（树形菜单+列表） | ✅ 完成 | 2025-12-26 |
| 班级干部信息管理API | 班级干部信息管理（含用户角色关联） | ✅ 完成 | 2025-01-27 |
| 班干部管理API | 班级干部职务管理 | ✅ 完成 | 2025-01-27 |
| 班级教师关联管理API | 班主任辅导员关联关系 | ✅ 完成 | 2025-01-27 |
| 学生考核管理系统API | 学生综合素质测评、违纪处分、奖励加分管理 | ✅ 完成 | 2025-01-27 |
| 学生考核管理系统修改方案 | 基于标准化违纪处分等级的系统升级方案 | 📋 方案 | 2025-01-27 |
| 学生考核管理系统数据库修改影响分析 | 数据库升级脚本执行的详细影响分析 | 📊 分析 | 2025-01-27 |