# API文档总览

本文档提供心理咨询预约系统所有API接口的总览，便于开发人员快速查找和使用。

## 基础规范

请参考 [API文档基础规范](./API文档基础规范.md) 了解通用的API调用规范、认证方式和响应格式。

## API模块列表
- [学生信息管理API](./学生信息管理API.md)
- [学生信息收集批次管理API](./学生信息收集批次管理API.md)
- [班级信息管理API](./班级信息管理API.md)
- [班级干部信息管理API](./班级干部信息管理API.md)
- [宿舍管理API](./宿舍管理API.md)
- [宿舍管理员信息API](./宿舍管理员信息API.md)
- [宿舍管理员授权API](./宿舍管理员授权API.md)
- [学生管理员授权关系API](./学生管理员授权关系API.md)

### 1. 用户认证登录

[用户认证登录API](./用户认证登录API.md) - 包含用户登录、获取用户信息、修改密码等接口。

### 2. 心理咨询预约

#### 2.1 预约管理

[心理咨询预约管理API](./心理咨询预约管理API.md) - 包含预约时段管理、预约申请、预约处理等接口。

#### 2.2 咨询师管理

[心理咨询师管理API](./心理咨询师管理API.md) - 包含咨询师信息管理、排班管理等接口。

#### 2.3 预约限制管理

[预约限制功能API](./预约限制功能API.md) - 包含未到访记录管理、预约限制检查、限制解除等接口。

### 3. 心理健康测评

[心理健康测评API](./心理健康测评API.md) - 包含测评问卷管理、测评结果分析等接口。


### 4. 统计报表

## 宿舍管理员信息API

- [宿舍管理员信息API](./宿舍管理员信息API.md)：包含宿舍管理员信息的增删改查接口
  - 支持不同类型宿舍管理员(全校管理员、自定义管理员、班主任)的管理
  - 提供获取可用教职工信息的接口，支持选择教职工作为宿舍管理员
  - **新增功能**: 在添加管理员时，通过下拉选择可用教师，支持模糊搜索，并自动填充选中教师的手机号码和性别信息

**核心功能**:
- 宿舍管理员信息分页查询（支持多条件搜索）
- 宿舍管理员信息新增、修改、删除
- 宿舍管理员信息导出
- 获取可用教职工信息列表（排除已经成为指定类型管理员的人员）
- 教师选择下拉搜索组件，支持模糊搜索和自动填充数据

**API基础路径**: `/xgStudentManager/studentManager`

**最新更新**:
- 2025-07-25: 优化管理员添加界面，将姓名输入框改为可搜索的下拉选择框，选择后自动填充教师信息
- 2025-07-24: 完成宿舍管理员信息管理模块的API接口设计
- 2025-07-24: 添加获取可用的教职工信息列表接口，支持根据管理员类型筛选可用教职工

**详细文档**: [宿舍管理员信息API.md](./宿舍管理员信息API.md)

## 企业信息管理API


[统计报表API](./统计报表API.md) - 包含各类统计数据查询接口。

## 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 |
| 记录咨询结果 | 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 | 预约限制 | - |

## 更新历史


| 日期 | 版本 | 更新内容 | 更新人 |
|------|------|---------|-------|
| 2025-07-01 | 1.0 | 初始版本 | 系统管理员 |
| 2025-07-15 | 1.1 | 添加心理健康测评API | 张工 |
| 2025-07-30 | 1.2 | 添加预约限制功能API | Cursor |

**详细文档**: [企业信息管理API.md](./企业信息管理API.md)

- [获取当前正在教学的班主任信息](/docs/开发文档/API/宿舍管理员信息API.md#获取当前正在教学的班主任信息)

---

## �� 最新更新日志

### 2025-01-27 - 新增班级学生查询接口
- **新增功能**: 新增 `GET /studentMsg/studentMsg/listByClassId` 接口
- **功能描述**: 查询指定班级中所有在籍学生信息
- **过滤条件**: 
  - `deleted = 0` (未删除)
  - `student_status = '1'` (在籍状态)
  - `class_id = 入参的classId` (班级ID)
  - `name LIKE '%入参的name%'` (姓名模糊查询，可选)
- **排序方式**: 按创建时间倒序排列
- **权限要求**: `studentMsg:studentMsg:query`

### 2025-07-24 - 学生信息管理界面重构
- **界面重构**: 学生信息管理新增弹窗调整为多tab页形式
- **功能增强**: 新增照片上传功能，支持完整的学生信息录入
- **数据扩展**: 支持60+个学生信息字段，包括：
  - 基础信息: 学号、身份证号、姓名、性别、出生日期、民族、籍贯、政治面貌、照片等
  - 扩展信息: 文化程度、户口类型、宗教信仰、生源地区、紧急联系人、特殊情况标记等
  - 家庭信息: 父母信息、监护人信息、家庭经济状况等
  - 健康信息: 身高、体重、血型、健康状况、疾病史、过敏史等
  - 学籍信息: 录取类别、学籍状态、入学信息、专业班级、宿舍信息等
  - 银行卡信息: 银行卡号、开户银行等
- **技术改进**: 使用el-tabs组件管理多个表单页面，提升用户体验

### 2025-07-01 - API文档架构重构
- **重要重构**: 将原本集中的大型API文档按业务模块拆分，提升维护效率
- **新增**: API文档模板，用于新API文档的生成
- **优化**: 目录结构，按功能模块分类管理

## 🔗 API文档导航

### 👥 学工管理模块

| API文档 | 描述 | 状态 | 更新时间 |
|---------|------|------|----------|
| [学生信息收集批次管理API](./学生信息收集批次管理API.md) | 学生信息收集批次班级权限管理 | ✅ 完成 | 2025-01-27 |
| [学生信息批次收集API](./学生信息批次收集API.md) | 学生信息批次收集管理（新增） | ✅ 完成 | 2025-01-27 |
| [班级信息管理API](./班级信息管理API.md) | 班级基础信息增删改查 | ✅ 完成 | 2025-01-27 |
| [班级干部信息管理API](./班级干部信息管理API.md) | 班级干部信息管理（含用户角色关联） | ✅ 完成 | 2025-01-27 |
| [班干部管理API](./班干部管理API.md) | 班级干部职务管理 | ✅ 完成 | 2025-01-27 |
| [班级教师关联管理API](./班级教师关联管理API.md) | 班主任辅导员关联关系 | ✅ 完成 | 2025-01-27 |