主要使用场景:
根据学校ID来查询学校首页的班级风采年级/班级列表
a.获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/space/getClasssTyleList?accessToken=ACCESS_TOKEN |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 否 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
schoolId |
必选 |
Body(json) |
String |
32 |
学校ID |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
retCode |
必选 |
String |
6 |
000000:表示成功 200014:学校ID不能为空 100000:查询失败 |
2 |
retDesc |
可选 |
String |
100 |
返回描述 |
3 |
classsTyleList |
必选 |
JSON |
- |
返回列表 |
3.1 |
gradeId |
可选 |
String |
32 |
年级ID |
3.2 |
gradeName |
可选 |
String |
64 |
年级名称 |
3.3 |
classList |
可选 |
JSON |
- |
该年级下的班级数组 |
3.3.1 |
classAlias |
可选 |
String |
64 |
班级别用名 |
3.3.2 |
classCode |
可选 |
String |
16 |
班级编号 |
3.3.3 |
classId |
可选 |
String |
32 |
班级ID |
3.3.4 |
className |
可选 |
String |
100 |
班级名称 |
3.3.5 |
eduSysType |
可选 |
String |
16 |
学制 |
3.3.6 |
foundTime |
可选 |
String |
16 |
入学年份 |
3.3.7 |
grade |
可选 |
String |
32 |
年级ID |
3.3.8 |
gradeClass |
可选 |
String |
16 |
所属班级、班别、班号: 1班、2班、3班 |
3.3.9 |
graduationTime |
可选 |
String |
16 |
毕业年份 |
3.3.10 |
headTeacherId |
可选 |
String |
32 |
班主任ID |
3.3.11 |
headTeacherName |
可选 |
String |
64 |
班主任名称 |
3.3.12 |
orgaCategory |
可选 |
String |
1 |
学校类型 0:小学,六三制:1-6,五四制:1-5 1:初中,六三制:1-3,五四制:1-4 2:高中,高中1-3 3:完中,初中一年级到高中三年级 4:机构,电教馆或教育局 5:教学点,小学一年级到六年级 6:九年一贯制,小学一年级到初中三年级 7: 十二年一贯制,小学一年级到高中三年级 9: 其它教育类学校 10: 中职 11: 高职 12:幼儿园 |
3.3.13 |
orgaId |
可选 |
String |
32 |
学校ID |
3.3.14 |
studyPhase |
可选 |
String |
32 |
学段 |
请求报文: { "schoolId":"F6C68AAFA3DB437CE040007F01001D3D" } 返回报文: { "retCode": "000000", "classsTyleList": [ { "gradeId": "5", "classId": "6772de807766424b8e900c3d4168f3dd", "className": "五年级[1]班", "imgUrl": "http://www.t.huijiaoyun.com/uploads/avatar/data/2/0/6772de807766424b8e900c3d4168f3dd_90x90.jpg?1474945327", "total": 18 }, ... { "gradeId": "5", "classId": "974f2cffadb04f4caa0f12d1aa65a4b6", "className": "五年级(2)班", "imgUrl": "http://css.huijiaoyun.com/tianyu_edu_test/common/images/avatar/class.png?2016", "total": 0 } ] }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
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 |
消息体的关键字对应的值 |