top
关闭

开发者登录

机构基本信息API

主要使用场景:需要获取机构信息时使用,包括机构基本信息、层级关系和管理员信息

1、获取机构基本信息

根据id获取机构或学校的基本表信息。

前置条件

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

请求说明

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

参数说明

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

1

orgId

必选

String

64.0

机构id

返回说明

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

1

retCode

必选

String

6.0

返回码

2

retDesc

可选

String

100.0

返回码描述

3

orgInfo

可选

Json对象

-

机构信息对象

3.1

orgId

可选

String

64.0

机构Id

3.2

orgCode

可选

String

64.0

机构代码

3.3

orgSummary

可选

String

1000.0

机构简介

3.4

orgPic

可选

String

512.0

机构图片

3.5

orgName

可选

String

300.0

机构名称

3.6

orgCage

可选

String

2.0

机构类别
0:小学,小学一年级到六年级
1:初中,初中一年级到初中三年级
2:高中,高中一年级到高中三年级
3:完中,初中一年级到高中三年级
4:机构,电教馆或教育局
5:教学点,小学一年级到六年级
6:九年一贯制,小学一年级到初中三年级
7:十二年一贯制,小学一年级到高中三年级
8:高等教育
9:其他教育类学校
10:中职
11:高职
12: 学前教育

3.7

provinceCode

可选

String

10.0

所属省份

3.8

cityCode

可选

String

10.0

所属城市

3.9

areaCode

可选

String

10.0

所属区县

3.10

createTime

可选

String

32.0

创建时间

3.11

orgType

可选

String

2.0

机构类型
1:国家
2:区域
3:市
4:区

示例

							请求报文:
{
    "orgId": "AF5C6A7A49124B20B8A******"
}
应答报文:
{
    "retCode":"000000",
    "retDesc": "success",
    "orgInfo": 
        {
        "areaCode": ,
        "cityCode": ,
        "createTime": "2013-10-13 21:09:33",
        "orgCage": "4",
        "orgCode": "130903",
        "orgId": "AF5C6A7A49124B20B8A******",
        "orgName": "运河区",
        "orgSummary": ,
        "orgType": "2",
        "provinceCode": 
        }
    ,
    "retDesc": "success"
}                          
						

2、获取下级机构列表

根据机构Id获取下级机构和学校的列表信息

前置条件

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

请求说明

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

参数说明

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

1

orgId

可选

String

64.0

机构Id

2

type

可选

String

1.0

机构类型
0:全部
1:学校
2:机构

3

start

可选

Int

8.0

获取开始记录下标,从1开始

4

end

可选

Int

8.0

获取结束记录下标

返回说明

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

1

retCode

可选

String

6.0

返回码

2

retDesc

可选

String

100.0

返回码描述

3

start

可选

String

8.0

获取开始位置,从1开始

4

end

可选

String

8.0

获取结束位置

5

count

可选

String

8.0

总记录条数

6

orgList

可选

JSON对象

-

机构信息列表

6.1

orgId

可选

String

64.0

机构Id

6.2

orgCode

可选

String

64.0

机构唯一代码

6.3

orgName

可选

String

300.0

机构名称

6.4

orgCage

可选

String

1.0

机构类别
0:小学,小学一年级到六年级
1:初中,初中一年级到初中三年级
2:高中,高中一年级到高中三年级
3:完中,初中一年级到高中三年级
4:机构,电教馆或教育局
5:教学点,小学一年级到六年级
6:九年一贯制,小学一年级到初中三年级
7:十二年一贯制,小学一年级到高中三年级
8:高等教育
9:其他教育类学校
10:中职
11:高职
12: 学前教育

6.5

provinceCode

可选

String

10.0

所属省份

6.6

cityCode

可选

String

10.0

所属城市

6.7

areaCode

可选

String

10.0

所属区县

6.8

createTime

可选

String

20.0

创建时间

示例

							请求报文:
{
    "orgId":"AF5C6A7A49124B20B8A*****",
     "type":"1",
    "start":"1",
    "end":"2"
}
应答报文:
{
    "retCode": "000000",
    "start": "1",
    "end": "2",
    "count": "389393",
    "orgList": [
        {
        "areaCode": ,
        "cityCode": ,
        "createTime": "2013-10-13 21:09:33",
        "orgCage": "4",
        "orgCode": "130903",
        "orgId": "AF5C6A7A49124B20B8A*****",
        "orgName": "运河区",
        "provinceCode": 
        }
    ],
    "retDesc": "success"
}
						

3、获取机构管理员列表

根据机构id获取机构的管理员身份列表信息

前置条件

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

请求说明

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

参数说明

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

1

orgId

必选

String

64.0

机构Id

返回说明

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

1

retCode

必选

String

6.0

返回码

2

retDesc

必选

String

100.0

返回码描述

3

count

必选

String

8.0

总记录条数

4

adminList

可选

Json对象

-

机构管理员用户信息列表

4.1

persionId

可选

String

64.0

用户个人Id

4.2

name

可选

String

100.0

用户姓名

4.3

userType

可选

String

1.0

用户类型
0:学生
1:老师
2:家长
3:机构
4:学校
5:学校工作人员
6:机构工作人员

4.4

gender

可选

String

1.0

性别
0:女
1:男

示例

							请求报文:
{
    "orgId": "AF5C6A7A49124B20B8A******",
    "start":"1",
    "end":"2"
}
应答报文:
{
    "retCode": "000000",
    "start": "1",
    "end": "2",
    "count": "10",
    "adminList": [
        {
        "persionId": "AF5C6A7A******",
        "name": "刘******",
        "userType": "2013-10-13 21:09:33",
        "gender": "4"
        }
    ],
    "retDesc": "success"
}           
						

参数说明

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

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

消息体的关键字对应的值