top
关闭

开发者登录

组织机构接口7.0

主要使用场景:组织机构接口7.0

1、获取学校教育组织节点详情7.0

基础 需要授权

该接口能获取到校区、学段、年级、班级的详情

前置条件

请求说明

url http://api.qnzedu.cn/user/openapi/org/get-edu-info?org_id=123&accessToken={{accessToken}}
请求方式 get
是否需要鉴权
请求数限制
接口方向 第三方应用->开放平台

参数说明

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

1

org_id

必选

string

节点id

返回说明

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

1

code

必选

string

结果编码,000000:成功, 100001:失败

2

message

必选

string

结果描述

3

result

必选

string

结果数据

3.1

org_id

必选

string

部门id

3.1

top_org_id

必选

string

学校id

3.2

grade_number

可选

Int

年级70版本编号(班级、年级时返回)

3.2

platform_org_id

必选

string

原平台组织id

3.3

graduation_header_teacher

可选

array

班主任数据,(班级毕业时返回)

3.3

platform_code

必选

string

原平台组织平台码

3.4

org_name

必选

string

组织名称

3.5

org_short_name

必选

string

组织简称

3.6

org_type

必选

string

组织类型(3:校区,5:学段,6:年级,7班级)

3.7

create_user_id

必选

string

创建者id

3.8

createtime

必选

string

创建时间

3.9

updatetime

必选

string

更新时间

3.11

parent_id

必选

string

父级节点id

3.12

group_id

可选

string

群组id

3.13

status

必选

string

状态,0:组织未激活,1:正常,2:解散,3:锁定

3.14

certification

必选

string

认证(0:未认证,1:已认证)

3.15

flag

必选

string

标记(0:正常,1:演示,2:测试)

3.16

level

必选

string

业务等级(0:无等级,1:等级一,2:等级二)

3.17

verify_mode

必选

string

成员加入模式(1允许加入,2不允许加入)

3.18

top_school_id

必选

string

校区id(班级、年级、学段、校区时返回)

3.19

class_number

可选

Int

班级编号(班级时返回)

3.21

grade_rule_number

可选

Int

年级的60版本编号(班级、年级时返回)

3.22

period_type

可选

Int

学段类型(班级、年级、学段时返回)

3.23

grade_year

可选

Int

入学年份(年级、班级时返回)

3.24

grade_system

可选

string

年级的学制类型(年级、班级时返回)

3.25

grade_system_name

可选

string

学制名称,(年级、班级时返回)

3.26

avatar

可选

string

头像地址,(校区、班级时返回)

3.27

graduation_is

可选

int

是否已毕业,(0未毕业,1已毕业;年级、班级时返回)

3.28

graduation_year

可选

string

毕业年份,(年级、班级时返回)

3.29

graduation_school_name

可选

string

毕业时的学校名称,(班级毕业时返回)

3.31

top_org_name

可选

string

学校的名称

3.32

org_coding

可选

string

班级编码(班级时返回)

示例

							请求示例
http://api.qnzedu.cn/user/openapi/org/get-edu-info?org_id=123&accessToken={{accessToken}}
返回示例
{
  "code": "000000",
  "message": "请求成功",
  "result": {
    "org_id": "c2d2a224-5a9a-11e9-9c82-0200f7b88099",
    "platform_org_id": "c2d2a224-asas-11e9-9c82-0200f7b88099",
    "platform_code": "999999",
    "org_name": "校区一",
    "org_short_name": "校区一",
    "org_type": "3",
    "create_user_id": "af144ae4-cccc-11e9-9c82-0200f7b88099",
    "createtime": "1554795635",
    "updatetime": "1555126603",
    "status": "1",
    "certification": "0",
    "flag": "0",
    "level": "0",
    "verify_mode": "0",
    "top_org_id": "c2d2a224-dddd-11e9-9c82-0200f7b88099",
    "parent_id": "c2d2a224-dddd-11e9-9c82-0200f7b88099",
    "top_school_id": "c2d2a224-5a9a-11e9-9c82-0200f7b88099",
    "top_org_name": "xxxx学校",
  }
}
						

参数说明

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

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

消息体的关键字对应的值

-->