top
关闭

开发者登录

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

主要使用场景：学校信息类接口

1、班级的教师、学生成员列表

基础 需要授权

利用班级id查询教师、学生成员列表

前置条件

获取接口访问令牌：accessToken

请求说明

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

参数说明

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

1

top_org_id

必选

String

-

 学校id

2

org_id

必选

String

-

 班级id

3

user_type

可选

String

-

 1:教师，0:学生，默认查所有

4

page

可选

Int

-

 分页，默认1

5

page_size

可选

Int

-

 数量，默认10,上限100

6

need_field

可选

String

-

 增加返回的字段，多个英文逗号分隔(student_staff_id学生证号;student_exam_id学生考号;esn可信教育数字身份号)

返回说明

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

1

code

必选

String

-

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

2

message

必选

String

-

 结果描述

3

result

必选

json

-

 结果

3.1

page

必选

Int

-

 分页

3.2

page_size

必选

Int

-

 查询量

3.3

count

必选

Int

-

 总数

3.4

member_list

必选

json

-

 成员列表

3.4.1

user_id

必选

string

-

 用户id

3.4.2

name

必选

string

-

 姓名

3.4.3

gender

必选

string

-

 性别

3.4.4

user_type

必选

Int

-

 用户类型（0学生，1老师）

3.4.5

avatar_list

必选

json

-

 用户头像（1:小, 2:中, 3:大）

3.4.6

create_time

必选

Int

-

 加入时间

3.4.7

subject

可选

json

-

 任教学科，老师时返回

3.4.7.1

subject_id

必选

string

-

 学科id

3.4.7.2

subject_name

必选

string

-

 学科名

3.4.8

subject_names

必选

string

-

 学科名的集合(语文/数学)

3.4.9

role_type

必选

string

-

 角色类型(header_teacher班主任；teacher老师；member成员)

3.4.10

student_class_number

可选

string

-

 班级学号(学生时才有)

3.4.11

student_staff_id

可选

string

-

 学生证号(need_field传入时才返回)

3.4.12

student_exam_id

可选

string

-

 学生考号(need_field传入时才返回)

示例

**请求示例**
https://api.wuhaneduyun.cn/user/openapi/org/get-class-member-list?top_org_id=xxx&org_id=xxx
**返回示例：**
{
    "code": "000000",
    "message": "成功",
    "result": {
        "page": 1,
        "page_size": 10,
        "count": 3,
        "member_list": [
            {
                "user_id": "xxx",
                "name": "zzzz",
                "gender": "2",
                "user_type": 1,
		"role_type": "teacher",
		"avatar_list": {
                    "1": "",
                    "2": "",
                    "3": ""
                },
		"create_time": 1554963535,
                "subject": [
                    {
                        "subject_id": "11",
                        "subject_name": "品德与生活（社会）"
                    },
                    {
                        "subject_id": "13",
                        "subject_name": "语文"
                    }
                ]
            }
        ]
    },
    "_timestamp": "1559131523.8804",
    "_runtime": "0.0747"
}