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

3、根据班级Id查询单个班级信息

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

前置条件

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

请求说明

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

参数说明

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

1

classId

必选

String

32

班级Id

2

spaceType

必选

String

1

班级空间类型:0:现有1:历史

返回说明

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

1

retCode

可选

String

6

000000:成功100098 必填参数不能为空100099 参数错误301999 usessionid验证失败301108 该用户没有权限301104 班级不存在300200 班级已经升级300201 高年级班级尚未升级,不可做升级操作

2

classInfo

可选

JSON

-

班级信息

2.1

orgId

可选

String

32

学校ID

2.2

orgName

可选

String

64

学校姓名

2.3

classId

可选

String

32

班级ID

2.4

className

可选

String

64

班级名称

2.5

gradeClass

可选

String

16

所属班级、班别、班号:1班、2班、3班

2.6

classAlias

可选

String

64

班级别名

2.7

grade

可选

Int

1

年级,六三制:1:一年级 2:二年级 3:三年级?4:四年级 5:五年级 6:六年级7:初一 8:初二 9:初三五四制:1:一年级 2:二年级 3:三年级?4:四年级 5:五年级6:初一 7:初二 8:初三 9:初四高中:10:高一 11:高二 12:高三幼儿园:-4:小小班 -3:小班 -2:中班-1:大班 0:学前班

2.8

eduSysType

可选

Int

1

学制1:六三制2:六四制

2.9

orgCategory

可选

Int

1

学校类型0:小学,六三制:1-6,五四制:1-51:初中,六三制:1-3,五四制:1-42:高中,高中1-33:完中,初中一年级到高中三年级4:机构,电教馆或教育局5:教学点,小学一年级到六年级6:九年一贯制,小学一年级到初中三年级7: 十二年一贯制,小学一年级到高中三年级9: 其它教育类学校10: 中职11: 高职12:幼儿园

2.10

studyPhase

可选

Int

1

班级所属学段,0:小学;1:初中;2:高中;3:幼儿园

2.11

foundTime

可选

String

16

入学年份

2.12

graduationTime

可选

String

16

毕业年份,毕业年份为现有班级数据,历史班级,请使用 2.19 的operateTime

2.13

headTracherId

可选

String

32

班主任ID

2.14

headTeacherName

可选

String

64

班主任姓名

2.15

teacherList

可选

JSON[]

-

任课教师

2.15.1

personId

可选

String

32

教师ID

2.15.2

gender

可选

String

1

性别,0是女,1为男

2.15.3

userName

可选

String

32

教师姓名

2.15.4

subjectList

可选

JSON[]

-

学科信息

2.15.4.1

subjectId

可选

String

32

学科ID

2.15.4.2

subjectName

可选

String

64

学科名称

2.16

memberList

可选

JSON[]

-

班级成员信息

2.16.1

personId

可选

String

32

成员ID

2.16.2

userName

可选

String

64

成员姓名

2.16.3

gender

可选

String

1

性别,0是女,1为男

2.17

classCode

可选

String

16

班级编号

2.18

status

可选

String

1

历史班级数据:该历史班级的状态:0:已升级1:已解散2:已毕业班

2.19

operateTime

可选

String

100

历史班级数据:转成历史班级的年份,如已解散的班级,则为班级解散时间;如已升级的班级,则为班级升级时间;如已毕业的班级,则为班级毕业时间如:2017

2.2

classRemar

可选

String

100

历史班级数据:备注信息:毕业班级的评价备注等等

3

retDesc

必选

String

100

说明

示例

							暂无
						

4、查询上课时间表

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

前置条件

获取接口访问凭证:accessToken

请求说明

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

参数说明

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

1

gradeId

可选

String

32

年级ID(当传AAM的班级ID时此处可不传)

2

classId

必选

String

32

班级ID(AAM班级ID 或者尚蠡的班级ID,当传尚蠡的班级ID时,年级ID必须传)

3

orgId

必选

String

32

学校机构ID

4

date

必选

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

教室名称

示例

							请求报文:
{
"orgId":"3B83C573B8BBA59AE050A8C08E061DF1",
"classId":"c201701",
"gradeId":"c2017",
"date":"2017-10-23 14:22:00"
}
返回报文:
{
    "data": [
        {
            "classRoom": "101",
            "courseName": "语文",
            "finishClassTime": "08:45",
            "attendClassTime": "08:00",
            "teacherName": "陈老师",
            "timePeriod": "1",
            "week": "1"
        },
        {
            "classRoom": "101",
            "courseName": "数学",
            "finishClassTime": "09:45",
            "attendClassTime": "09:00",
            "teacherName": "语文老师",
            "timePeriod": "1",
            "week": "1"
        },
        {
            "classRoom": "101",
            "courseName": "英语",
            "finishClassTime": "10:45",
            "attendClassTime": "10:00",
            "teacherName": "数学老师",
            "timePeriod": "1",
            "week": "1"
        },
        {
            "finishClassTime": "11:45",
            "attendClassTime": "11:00",
            "timePeriod": "1",
            "week": "1"
        },
        {
            "classRoom": "101",
            "courseName": "语文",
            "finishClassTime": "15:15",
            "attendClassTime": "14:30",
            "teacherName": "陈老师",
            "timePeriod": "2",
            "week": "1"
        },
        {
            "classRoom": "101",
            "courseName": "数学",
            "finishClassTime": "16:15",
            "attendClassTime": "15:30",
            "teacherName": "语文老师",
            "timePeriod": "2",
            "week": "1"
        },
        {
            "classRoom": "101",
            "courseName": "英语",
            "finishClassTime": "17:15",
            "attendClassTime": "16:30",
            "teacherName": "数学老师",
            "timePeriod": "2",
            "week": "1"
        },
        {
            "classRoom": "101",
            "courseName": "语文",
            "finishClassTime": "20:00",
            "attendClassTime": "19:00",
            "teacherName": "陈老师",
            "timePeriod": "3",
            "week": "1"
        }
    ],
    "retCode": "000000",
    "retDesc": "成功"
}
						

参数说明

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

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

消息体的关键字对应的值