top
关闭

开发者登录

班级基本信息API

主要使用场景:需要获取班级信息时使用,包括学校的单个班级信息、班级列表信息和班级成员信息

1、获取班级列表

根据班级相关条件获取班级的列表。 排序:入学年份降序、年级升序。

前置条件

a、获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/baseInfo/class/queryClassList?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

1

orgId

必选

String

64.0

学校Id

2

classId

可选

String

64.0

班级Id

4

start

可选

Int

8.0

获取开始记录下标

5

end

可选

Int

8.0

获取结束记录下标

返回说明

序号 字段名 约束 类型 长度 说明

1

retCode

必选

String

6.0

返回码

2

retDesc

必选

String

100.0

返回码描述

3

start

必选

Int

8.0

获取开始位置,从1开始

4

end

必选

Int

8.0

获取结束位置

5

count

必选

String

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

classAlias

可选

String

50.0

班级别名

6.9

graduationTime

可选

String

4.0

毕业年份

6.10

classType

可选

String

1.0

班级类别
0:普通
1:实验

6.11

classCode

可选

String

8.0

班级编号

示例

							请求报文:
{
    "orgId" : "3e0cc962a5824168a******",
    "start": "1",
     "end": "2"
}
应答报文:
{
    "retCode": "000000",
    "count": "1",
    "start": "1",
    "classList": [
        {
        "classCode": "j180ykha",
        "classId": "294e8a5f96ee4cefba9******",
        "className": "高******班",
        "foundTime": "2015",
        "grade": "10",
        "gradeClass": "1",
        "graduationTime": "2018",
        "headTeacherId": "b4401d540b164c6b9cc******",
        "headTeacherName": "老师******"
         }
    ],
    "end": "2"
}
						

2、获取班级成员信息

根据班级id获取班级成员信息。

前置条件

a、获取接口访问凭证:accessToken

请求说明

url http://opengate.huijiaoyun.com/baseInfo/class/queryClassMember?accessToken=ACCESS_TOKEN
请求方式 post
格式 json
是否需要鉴权
请求数限制
接口方向 第三方应用>开放平台

参数说明

序号 字段名 约束 类型 长度 说明

1

classId

必选

String

64

班级Id

2

start

必选

Int

8

记录开始数

3

end

必选

Int

8

记录结束数

返回说明

序号 字段名 约束 类型 长度 说明

1

retCode

必选

String

6.0

结果 000000:成功

2

start

必选

Int

8.0

获取开始位置

3

end

必选

Int

8.0

获取结束位置

4

count

必选

Int

8.0

总记录条数

5

userList

可选

Json对象

-

成员信息列表

5.1

personId

可选

String

60.0

用户的统一ID

5.2

name

可选

String

100.0

用户姓名

5.3

gender

可选

String

1.0

性别:0是女;1为男

5.4

userType

必选

String

1.0

用户类型: 学生:0 老师:1

示例

							请求报文:
{
    "classId": "00d81f28cdbf412c875******",
    "start": "1",
    "end": "10"
}
应答报文:
{
"userList" : [ {
 "gender" : "1",	
"name" : "刘老师",
"personId" : "4684920c01f040378d3******"
}]
"retCode" : "000000",
"count" : "5",
"start" : "1",
"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"
	}
}
											

参数说明

请求参数消息体-link类
序号 字段名 约束 类型 长度 说明

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"
	}
}
											

参数说明

请求参数消息体-oa类
序号 字段名 约束 类型 长度 说明

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

消息体的关键字对应的值