一、基本信息
接口名称:获取课表时间段数据接口
接口说明:获取当前学校某个时间段课表数据,包括行政班,教学班和选修班课表。
请求地址:{BASEURL}/dataconnectorserv/integration/scheduler/getPeriodSchedule
请求方式:POST
请求类型:application/json
接口频率:接口调用上限500次/天
接口版本:3.0
修改日期:2023-12-05
小提示
1、开始日期和结束日期最大不超过7天,最小1天,未填开始时间和结束时间,默认返回当天起7天内的课表数据。
2、在对接的班牌过程中,接口数据可能增加字段,但不会删减字段,解析json时,请处理。
二、请求参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| appKey | String | 是 | 平台提供的唯一标识 |
| schoolID | String | 是 | 学校ID,从学校列表获取 |
| beginDate | String | 是 | 课表开始日期,日期标准格式"YYYY-MM-DD",开始日期和结束日期最大不超过7天,最小1天。 |
| endDate | String | 是 | 课表结束日期,日期标准格式"YYYY-MM-DD",开始日期和结束日期最大不超过7天,最小1天。 |
{
"appKey": "36s2zllw",
"schoolID": "wca5opSRt2tyyBSLqOjdoS==",
"beginDate":"2023-10-17",
"endDate":"2021-10-18"
}
三、响应结果
小提示
1、开始日期和结束日期最大不超过7天,最小1天,未填开始时间和结束时间,默认返回当天起7天内的课表数据。
2、课表获取某个日期的课表数据,会返回历史课表,在返回历史的课表中,getLocations接口是获取基础数据当前最新场地信息与历史课表中的场地对应会有不同,请以返回课表场地为准或参考选择处理场地情况。
3、学期字段semester,查询历史课表学期字段可能为空,当前学期已结束,新学期未开始时,学期字段为空。
| 响应参数名称 | 响应参数类型 | 是否有值 | 说明 |
|---|---|---|---|
| semester | Object | 是 | 学校学期 |
| schedule | Array | 是 | 学校课表列表,每个对象代表一节课 |
| classFullName | String | 是 | 班级全称 |
| qualifiedClassID | String | 是 | 班级ID |
| classType | String | 是 | 班级类型 |
| weekDay | String | 是 | 上课周几,例如:1表示星期一 |
| date | String | 是 | 上课日期 |
| oddDual | String | 是 | 单双周:0表示非单双周,1单周,2双周,week 本周0,下周1,例如:本周上美术课,下周音乐课 |
| timeslot | String | 是 | 上课节次,例如:1表示第一节课 |
| beginTime | String | 是 | 上课时间(优先使用基础数据作息timeSettings) |
| endTime | String | 是 | 下课时间(优先使用基础数据作息timeSettings) |
| subjectID | String | 是 | 科目ID |
| subjectName | String | 是 | 科目名称 |
| teachers | Array | 否 | 教师列表 |
| teacherEID | String | 否 | 教师EID |
| teacherName | String | 否 | 教师姓名 |
| locationID | String | 否 | 教室ID |
| locationName | String | 否 | 教室名称 |
| timeSettings | Object | 是 | 基础作息(作息框架与作息时间),即将弃用,从基础作息接口获取 |
| daysPerWeek | String | 是 | 一周几天上课 |
| earlyMorningLessons | String | 是 | 早间节次数 |
| morningLessons | String | 是 | 上午节次数 |
| afternoonLessons | String | 是 | 下午节次数 |
| nightLessons | String | 是 | 晚间节次数 |
| times | Array | 否 | 每天节次时间安排【注:null值或空数组,表示有年级作息时,全校times作息为空】 |
| timeslotInDay | String | 否 | 上课节次,例如:1表示第一节课 |
| beginTime | String | 否 | 开始时间(分钟) |
| duration | String | 否 | 上课时间(分钟) |
| breakDuration | String | 否 | 课间时间(分钟) |
| gradeTimeSettings | Array | 否 | 年级作息 |
| grades | Array | 否 | 年级列表 |
| groupTimes | Array | 否 | 年级作息时间 |
| schoolDays | Array | 否 | 学校上课天数,表示一周作息的星期,1表示星期一,2表示星期二 |
| times | Array | 否 | 作息时间 |
| timeslotInDay | String | 否 | 上课节次,例如:1表示第一节课 |
| beginTime | String | 否 | 开始时间(分钟) |
| duration | String | 否 | 上课时间(分钟) |
| breakDuration | String | 否 | 课间时间(分钟) |
{
"status": "success",
"result": {
"semester": "2023-2024第一学期",
"schedule": [
{
"classFullName": "高二1班",
"qualifiedClassID": "1012023-1",
"classType": "行政班",
"weekDay": 1,
"date": "2023-10-17",
"oddDual": "0",
"timeslot": 4,
"beginTime": "10:30",
"endTime": "11:10",
"subjectID": "8",
"subjectName": "语文",
"teachers": [
{
"teacherEID": "1012022060",
"teacherName": "语文老师19"
}
],
"locationID": "26",
"locationName": "高二1班"
},
{
"classFullName": "高二地理7班",
"qualifiedClassID": "1012023-61",
"classType": "教学班",
"weekDay": 2,
"date": "2023-10-18",
"oddDual": "0",
"timeslot": 5,
"beginTime": "11:20",
"endTime": "12:00",
"subjectID": "6",
"subjectName": "地理",
"teachers": [],
"locationID": null,
"locationName": null
},
{
"classFullName": "篮球兴趣课",
"qualifiedClassID": "11010",
"classType": "选修班",
"weekDay": 4,
"date": "2023-10-18",
"oddDual": "0",
"timeslot": 9,
"beginTime": "16:10",
"endTime": "16:50",
"subjectID": "1101",
"subjectName": "篮球兴趣课",
"teachers": [
{
"teacherEID": "1012022098",
"teacherName": "体育老师"
}
],
"locationID": "20",
"locationName": "多媒体教室"
}
],
"timeSettings": {
"daysPerWeek": 5,
"earlyMorningLessons": 0,
"morningLessons": 2,
"afternoonLessons": 3,
"nightLessons": 0,
"times": [
{
"timeslotInDay": 1,
"beginTime": "07:50",
"duration": 40,
"breakDuration": 10
},
{
"timeslotInDay": 2,
"beginTime": "08:40",
"duration": 40,
"breakDuration": 20
},
{
"timeslotInDay": 3,
"beginTime": "09:40",
"duration": 40,
"breakDuration": 10
},
{
"timeslotInDay": 4,
"beginTime": "10:30",
"duration": 40,
"breakDuration": 10
},
{
"timeslotInDay": 5,
"beginTime": "11:20",
"duration": 40,
"breakDuration": 0
}
]
},
"gradeTimeSettings": []
}
}