排课系统帮助中心

排课系统数据导出接口是锦中排课系统提供的一种标准化接口，用于将系统中的课程安排、教师信息、教室资源等数据以结构化格式（如JSON或CSV）导出。该接口支持多种查询条件和数据筛选方式，适用于数据备份、数据分析、第三方系统集成等场景。

 

一、接口概述

 

1. 接口地址

数据导出接口的访问地址为：https://api.jinzong.com/course/export

 

2. 请求方式

接口支持GET和POST两种请求方式，推荐使用POST方式以提高安全性。

 

3. 请求头

- Content-Type: application/json

- Authorization: Bearer [token]（需在请求头中携带有效的身份验证令牌）

 

4. 响应格式

接口返回的数据格式为JSON或CSV，具体由请求参数指定。

 

二、接口参数说明

 

1. 必选参数

- token：用户身份验证令牌，用于确保请求合法性。

- format：数据格式，可选值为json或csv，默认为json。

- type：导出数据类型，可选值包括course（课程）、teacher（教师）、classroom（教室）、schedule（课表）等。

 

2. 可选参数

- start_date：起始日期，格式为YYYY-MM-DD，用于筛选特定时间段内的数据。

- end_date：结束日期，格式为YYYY-MM-DD，用于筛选特定时间段内的数据。

- school_id：学校ID，用于限定导出数据所属的学校范围。

- class_id：班级ID，用于限定导出数据所属的班级范围。

- teacher_id：教师ID，用于限定导出数据所属的教师范围。

 

三、请求示例

 

示例1：导出所有课程数据（JSON格式）

POST https://api.jinzong.com/course/export

{

"token": "your_token_here",

"format": "json",

"type": "course"

}

 

示例2：导出指定时间段内所有课表数据（CSV格式）

POST https://api.jinzong.com/course/export

{

"token": "your_token_here",

"format": "csv",

"type": "schedule",

"start_date": "2025-03-01",

"end_date": "2025-03-31"

}

 

四、响应示例

 

成功响应：

{

"code": 200,

"message": "成功",

"data": [

{

"course_id": "C001",

"course_name": "数学",

"teacher_id": "T001",

"classroom_id": "R001",

"start_time": "08:00",

"end_time": "09:40",

"date": "2025-03-01"

},

...

]

}

 

失败响应：

{

"code": 401,

"message": "未授权",

"data": null

}

 

五、错误码说明

 

- 200：操作成功

- 401：未授权，缺少或无效的token

- 400：请求参数错误

- 500：服务器内部错误

 

六、注意事项

 

1. 用户必须拥有相应的权限才能调用此接口。

2. 导出数据量较大时，建议分批次获取，避免影响系统性能。

3. 所有时间字段均采用UTC+8时区，请注意时区转换问题。

4. 导出数据中包含敏感信息，需妥善保存，防止泄露。

 

七、接口版本控制

 

当前接口版本为v1.0，后续如有更新将通过版本号进行管理。建议开发者在调用时指定版本号，例如：/api/v1.0/course/export。

 

八、技术支持

 

如在使用过程中遇到任何问题，可通过以下方式联系技术支持：

- 邮箱：support@jinzong.com

- 电话：400-123-4567

- 在线客服：https://www.jinzong.com/support

 

九、附录

 

1. 数据字段说明

- course_id：课程唯一标识

- course_name：课程名称

- teacher_id：教师唯一标识

- teacher_name：教师姓名

- classroom_id：教室唯一标识

- classroom_name：教室名称

- start_time：课程开始时间

- end_time：课程结束时间

- date：课程日期

 

2. 时间格式说明

- 日期格式：YYYY-MM-DD

- 时间格式：HH:mm（24小时制）

 

十、版本历史

 

- v1.0（2025-03-01）：初始版本，支持课程、教师、教室、课表数据导出功能。