top
关闭

开发者登录

概述
开放平台概述
接入指南
开发者注册
接口访问令牌
数据解密流程
应用接入规范
标准规范
开发者协议
违规处理规范
登录服务协议
公共返回码说明
系统字段说明
数据回流接口说明
API索引
1.身份验证
2.用户信息
3.机构信息
4.学校信息
5.学科信息
6.行政班
资源服务类
大数据指标类
其它
数据回流
调试工具
API调用说明
API调试工具
行政班接口

主要使用场景：行政班接口

1、班级(校区、学段、年级)详情

基础 需要授权

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

前置条件

获取接口访问令牌：accessToken

请求说明

urlhttps://api.wuhaneduyun.cn/user/openapi/org/get-edu-info?org_id=xxx
请求方式get
是否需要鉴权 是
请求数限制 否
接口方向第三方应用->开放平台

参数说明

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

1

org_id

必选

String

-

 节点id

2

get_more

可选

String

-

 是否查更多详情(1要查，0不查)默认不查

返回说明

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

1

code

必选

string

-

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

2

message

必选

string

-

 结果描述

3

result

必选

string

-

 结果数据

3.1

org_id

必选

string

-

 组织id

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.10

top_org_id

必选

string

-

 学校id

3.11

parent_id

必选

string

-

 父级节点id

3.13

status

必选

string

-

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

3.15

flag

必选

string

-

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

3.17

verify_mode

必选

string

-

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

3.18

top_school_id

必选

string

-

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

3.19

class_number

可选

Int

-

 班级编号(班级时返回)

3.20

grade_number

可选

Int

-

 年级数字编号，每个学段从1开始重新计算(幼小，高职，高等推荐使用)(班级、年级时返回)

3.21

grade_rule_number

可选

Int

-

 年级数字编号，k12编号，1到12(小初高)(班级、年级时返回)

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.30

graduation_header_teacher

可选

array

-

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

3.31

top_org_name

必选

string

-

 学校的名称

3.32

org_coding

可选

string

-

 班级编码(班级时返回)

3.33

introduction

可选

string

-

 简介信息(传入get_more，且是校区、班级时返回)

示例

**请求示例**
https://api.wuhaneduyun.cn/user/openapi/org/get-edu-info?org_id=xxx
**返回示例：**
{
  "code": "000000",
  "message": "请求成功",
  "result": {
    "org_id": "xxx",
    "platform_code": "999999",
    "org_name": "xx校区",
    "org_short_name": "xx校区",
    "org_type": "3",
    "create_user_id": "xxx",
    "createtime": "1554795635",
    "updatetime": "1555126603",
    "status": "1",
    "flag": "0",
    "verify_mode": "0",
    "top_org_id": "xxx",
    "parent_id": "xxx",
    "top_school_id": "xxx",
    "top_org_name": "xxxx学校"
  }
}