主要使用场景:
根据班级相关条件获取班级的列表。 排序:入学年份降序、年级升序。
获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/baseInfo/class/queryClassList?accessToken=ACCESS_TOKEN |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 是 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
orgId |
必选 |
Body(json) |
String |
64.0 |
学校Id |
2 |
classId |
可选 |
Body(json) |
String |
64.0 |
班级Id |
3 |
start |
可选 |
Body(json) |
String |
64 |
获取开始记录下标 |
4 |
end |
可选 |
Body(json) |
String |
64 |
获取结束记录下标 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
retCode |
必选 |
String |
6.0 |
返回码 |
2 |
retDesc |
必选 |
String |
100.0 |
返回码描述 |
3 |
start |
必选 |
Integer |
8.0 |
获取开始位置,从1开始 |
4 |
end |
必选 |
Integer |
8.0 |
获取结束位置 |
5 |
count |
必选 |
Integer |
8.0 |
总记录条数 |
6 |
classList |
可选 |
Json对象 |
- |
班级信息列表 |
6.1 |
classId |
可选 |
String |
64.0 |
班级ID |
6.2 |
className |
可选 |
String |
50.0 |
班级名称 |
6.3 |
gradeClass |
可选 |
Int |
- |
班别:相应的数字,代表相应班别,如:1代表1班 |
6.4 |
grade |
可选 |
Int |
- |
年级 0:学前班 1:一年级 2:二年级 3:三年级 4:四年级 5:五年级 6:六年级 7:初一 8:初二 9:初三 10:高一 11:高二 12:高三 |
6.5 |
foundTime |
可选 |
String |
32.0 |
入学年份 |
6.6 |
headTeacherId |
可选 |
String |
32.0 |
班主任ID |
6.7 |
headTeacherName |
可选 |
String |
10.0 |
班主任姓名 |
6.8 |
classCate |
可选 |
String |
50.0 |
班级属性:班级类别 0:普通;1:实验; |
6.9 |
graduationTime |
可选 |
String |
4.0 |
毕业年份 |
6.10 |
classCode |
可选 |
String |
8.0 |
班级编号 |
请求报文: { "orgId":"cc98fbc32dfd4ce69cc661c3fc09e939", "classId":"69466466b31d4bc9a84ae9433d72bb94", "start":"0", "end":"5" } 应答报文: { "retCode": "000000", "count": 2, "retDesc": "success", "start": 0, "classList": [ { "classCate": "0", "classCode": "jdi00ae4", "classId": "69466466b31d4bc9a84ae9433d72bb94", "className": "1班", "foundTime": "2013-01-01 00:00:00", "grade": "9", "gradeClass": "1", "graduationTime": "2016", "headTeacherId": "6d00e721a03b475ea4d470de1c763c30", "headTeacherName": "王静" }, { "classCate": "0", "classCode": "jdi00ae4", "classId": "69466466b31d4bc9a84ae9433d72bb94", "className": "1班", "foundTime": "2013-01-01 00:00:00", "grade": "9", "gradeClass": "1", "graduationTime": "2016", "headTeacherId": "5a971ff1ea254581bfef4ab0d4bfa86d", "headTeacherName": "李学松" } ], "end": 5 }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
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 |
消息体的关键字对应的值 |