top

关闭

开发者登录

返回开放文档
API导航
基础数据类API
机构基本信息API
用户基本信息API
班级基本信息API
认证会话类API
Oauth认证API
用户会话API
用户关系API

班级基本信息API

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

1、获取班级列表

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

前置条件

获取接口访问凭证：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
}

2、获取班级成员信息

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

前置条件

获取接口访问凭证：accessToken

请求说明

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

参数说明

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

1

classId

必选

Body(json)

String

-

 班级Id

2

start

必选

Body(json)

String

-

 记录开始数

3

end

必选

Body(json)

String

-

 记录结束数

返回说明

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

1

retCode

必选

String

-

 结果 000000:成功

2

retDesc

可选

string

-

 说明

3

start

必选

Integer

-

 获取开始位置

4

end

必选

Integer

-

 获取结束位置

5

count

必选

Integer

-

 总记录条数

6

userList

可选

Json对象

-

 成员信息列表

6.1

personId

必选

String

-

 用户的统一ID

6.2

name

可选

String

-

 用户姓名

6.3

gender

可选

String

-

 性别 0是女，1为男

6.4

userType

必选

String

-

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

6.5

studentrollno

必选

string

-

 学号ID

6.6

studentExamNo

可选

string

-

 考号

示例

							请求报文：
{
    "classId":"c565c0e5b57b41108fb2affdd01d0ecb",
    "start":"1",
    "end":"5"
}
应答报文：
{
   "retCode": "000000",
   "count": 448,
   "retDesc": "success",
   "start": 1,
   "userList":    [
            {
         "gender": "0",
         "name": "戴伦",
         "personId": "00e2b09b411443edb124a75e72cb0fb3",
         "userType": "0"
      },
            {
         "gender": "1",
         "name": "刘佳",
         "personId": "014b371db1d84563b87f6a47a077dfac",
         "userType": "0"
      },
            {
         "gender": "1",
         "name": "夏菁瑶",
         "personId": "020ad412a9b54585b2e9fa2e23068332",
         "userType": "0"
      },
            {
         "gender": "0",
         "name": "学生002的妈妈",
         "personId": "03cad8099e9946ebb56a53e2c72facd2",
         "userType": "2"
      }
   ],
   "end": 5
}

3、查询上课时间表

查询指定学校班级指定日期的课表

前置条件

获取接口访问凭证：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
}
Copyright© 2023 All rights reserved  
鄂公网安备 42018502000485号   鄂ICP备13001992号算法推荐相关举报入口
客户服务热线：4001801818

公众号: 天喻教育
关于天喻
公司简介
业务定位
资质证书
成果案例
开放平台
开发者首页
开发者文档
开发者协议
帮助反馈
在线客服
问题反馈
帮助中心
服务支持
服务条款
运营支持
应用监控
联系我们
服务网点
商务合作
证书查询

参数说明

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

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

消息体的关键字对应的值