接口文档格式
考勤接口说明
获取 AccessToken
接口描述
- 获取 AccessToken。正常情况下AccessToken有效期为604800秒,出于系统维护需要,可能提前使AccessToken失效。开发者应实现AccessToken失效时重试获取的逻辑。
请求URL:
http://10.32.162.30/berserker-auth/oauth/token
请求方式:
- POST
Header:
1 | Content-Type:application/x-www-form-urlencoded |
Authorization是 base64 编码
参数:
参数名 | 必须 | 类型 | 说明 |
---|---|---|---|
grant_type | 是 | String | 固定值:”password” |
scope | 是 | String | 固定值:”all” |
logintype | 是 | String | 固定值:”operator” |
username | 是 | String | 用户名 |
password | 是 | String | 密码 |
成功响应示例
1 | { |
响应参数
参数名称 | 参数说明 |
---|---|
access_token | 获取到的凭证 |
expires_in | 凭证的有效时间(秒) |
获取周课表
接口描述
- 根据日期(格式:”2019-10-01”)获取所在周课表。
请求URL:
http://10.32.162.30/attendance-teacher/thirdParty/weekScheduleByDate
请求方式:
- POST
Header:
1 | Content-Type:application/json |
参数:
参数名 | 必须 | 类型 | 说明 |
---|---|---|---|
lessonDate | 是 | String | 课程日期,格式:”2019-10-01” |
成功响应示例
1 | { |
响应参数
参数名称 | 参数说明 |
---|---|
campusName | 校区名称 |
campusCode | 校区代码 |
buildName | 楼栋名称 |
buildNum | 楼栋编号 |
roomName | 教室名称 |
roomNum | 教室编号 |
teacherName | 教师姓名 |
teacherNum | 教师编号 |
lessonName | 课程名称 |
lessonCode | 课程代码 |
lessonDate | 课程日期 |
lessonSection | 课程节次 |
lessonStartTime | 课程开始时间 |
lessonEndTime | 课程结束时间 |
获取学生考勤统计
接口描述
- 获取学生考勤统计
请求URL:
http://10.32.162.30/attendance-teacher/thirdParty/attendanceBySubject
请求方式:
- POST
Header:
1 | Content-Type:application/json |
参数:
注意:lessonSubsection
和 dateTime
传一个值即可;若两个都传,lessonSubsection
无效。
参数名 | 必须 | 类型 | 说明 |
---|---|---|---|
lessonDate | 是 | String | 课程日期,格式:”2019-10-01” |
dateTime | 否 | String | 格式:”2019-10-01 08:00:00”,通过该值判断所处 的小节次;若该时间点处于课间,将无结果返回。 该值会使 lessonSubsection 无效。 |
lessonSubsection | 否 | Int | 课程小节次,例如:第五节为 5 |
campusCode | 否 | String | 校区代码 |
buildNum | 否 | String | 楼栋编号 |
roomNum | 否 | String | 教室编号 |
lessonCode | 否 | String | 课程代码 |
成功响应示例
1 |
|
响应参数
参数名称 | 参数说明 |
---|---|
campusName | 校区名称 |
campusCode | 校区代码 |
buildName | 楼栋名称 |
buildNum | 楼栋编号 |
roomName | 教室名称 |
roomNum | 教室编号 |
teacherName | 教师姓名 |
teacherNum | 教师编号 |
lessonName | 课程名称 |
lessonCode | 课程代码 |
lessonDate | 课程日期 |
lessonSection | 课程节次,例如:”7-8” 为7、8节课 |
lessonStartTime | 课程开始时间 |
lessonEndTime | 课程结束时间 |
total | 应到(应到=正常+迟到+缺勤+请假) |
actualCount | 实到(实到=正常+迟到) |
normalCount | 正常 |
lateCount | 迟到 |
absenceCount | 缺勤 |
leaveCount | 请假 |