主要使用场景:
查询指定学校班级指定日期的课表
获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/baseInfo/class/getTimeTable?accessToken=ACCESS_TOKEN |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 否 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
gradeId |
可选 |
Body(json) |
String |
32 |
年级ID(当传AAM的班级ID时此处可不传) |
2 |
classId |
必选 |
Body(json) |
String |
32 |
班级ID(AAM班级ID 或者尚蠡的班级ID,当传尚蠡的班级ID时,年级ID必须传) |
3 |
orgId |
必选 |
Body(json) |
String |
32 |
学校机构ID |
4 |
date |
必选 |
Body(json) |
String |
18 |
查询某一天时传递该参数 格式:yyyy-MM-dd HH:mm:ss |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
retCode |
必选 |
String |
6 |
结果 000000 成功 000002 时间格式错误 000003 班级中无学生 000004 该班级无课表 其他失败 |
2 |
retDesc |
必选 |
String |
100 |
结果描述 |
3 |
data |
必选 |
JSON |
- |
返回结果集 |
3.1 |
week |
必选 |
Int |
1 |
星期几 取值范围 [1-7] |
3.2 |
timePeriod |
必选 |
Int |
1 |
1:上午 2:下午 3:晚上 |
3.3 |
lessSection |
必选 |
Int |
1 |
第几节课 |
3.4 |
className |
必选 |
String |
64 |
班级名称 |
3.5 |
gradeName |
必选 |
String |
64 |
年级名称 |
3.6 |
attendClassTime |
必选 |
String |
18 |
上课时间 |
3.7 |
finishClassTime |
必选 |
String |
18 |
下课时间 |
3.8 |
teacherName |
必选 |
String |
64 |
老师名称 |
3.9 |
courseName |
必选 |
String |
64 |
课程名称 |
3.10 |
classRoom |
必选 |
String |
64 |
教室名称 |
请求参数: { "groupId": "d4e8b27470db410f82548f1a9bf3aa82", "type": [ "0" ], "start": 0, "end": 2 } 返回参数: { "dataList": [ { "account": "tybb01", "fansCount": 0, "gender": "1", "name": "北北", "orgId": "d4e8b27470db410f82548f1a9bf3aa82", "orgName": "天喻测试小学", "personId": "c96561c9be7148d1b04b048c6384d61e", "status": "1", "userlogoList": [], "userType": "0" }, { "account": "tydd01", "fansCount": 0, "gender": "1", "name": "东东", "orgId": "d4e8b27470db410f82548f1a9bf3aa82", "orgName": "天喻测试小学", "personId": "95016c8fddea4c43a53b30d821841eb2", "status": "1", "userlogoList": [], "userType": "0" } ], "retCode": "000000", "count": 4, "start": 0, "end": 2 }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:text |
1.1 |
text |
必选 |
Json |
- |
text消息体 |
1.1.1 |
content |
必选 |
String |
消息内容 |
{ "msgtype": "text", "text": { "content": "zhxy msg text test 12" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:link |
2 |
link |
必选 |
Json |
- |
link消息体 |
2.1 |
pcUrl |
必选 |
String |
PC端消息点击链接地址 |
|
2.2 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
2.3 |
title |
必选 |
String |
消息标题 |
|
2.4 |
busiId |
必选 |
String |
对应业务的id |
|
2.5 |
content |
必选 |
String |
消息描述 |
|
2.6 |
picUrl |
必选 |
String |
图文消息的图片链接,支持JPG、PNG格式,较好的效果为大图640*320,小图80*80。如不填,在客户端不显示图片 |
{ "msgtype": "link", "link": { "pcUrl": "http://www.baidu.com", "appUrl": "http://www.baidu.com", "picUrl": "http://xxx.yyy.com/zzz.jpg", "content": "百度一下", "title": "百度", "busiId":"AQWER1234" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:oa |
2 |
busiId |
必选 |
String |
- |
该条oa消息在业务系统对应的id |
3 |
pcUrl |
必选 |
String |
消息点击链接地址 |
|
4 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
5 |
oa |
必选 |
Json |
- |
oa类型消息体 |
5.1 |
head |
必选 |
Json |
255 |
消息头部Json |
5.1.1 |
text |
必选 |
String |
255 |
消息的头部标题 |
5.1.2 |
bgColor |
可选 |
String |
消息头部的背景颜色。长度限制为8个英文字符,其中前2为表示透明度,后6位表示颜色值。不要添加0x。默认值:FFCC0000 |
|
5.2 |
body |
可选 |
Json |
消息体 |
|
5.2.1 |
title |
可选 |
String |
消息体的标题 |
|
5.2.2 |
content |
可选 |
String |
消息体的正文 |
|
5.2.3 |
imageUrl |
可选 |
String |
消息体中的图片url |
|
5.2.4 |
fileCount |
可选 |
String |
自定义的附件数目。此数字仅供显示,不作验证 |
|
5.2.5 |
author |
可选 |
String |
自定义的作者名字 |
|
5.2.6 |
form |
可选 |
Json数组 |
消息体的表单,最多6个 |
|
5.2.7 |
key |
可选 |
String |
消息体的关键字 |
|
5.2.8 |
value |
可选 |
String |
消息体的关键字对应的值 |