top
关闭

开发者登录

用户信息接口

主要使用场景:用户信息接口7.0

1、查询班级成员列表7.0

基础 需要授权

查询班级成员列表

前置条件

获取接口访问凭证:accessToken

请求说明

urlhttps://gateway.tianyuyun.com/user/openapi/org/get-class-member-list?top_org_id=***&org_id=***&accessToken={{accessToken}}
请求方式get
是否需要鉴权
请求数限制
接口方向第三方应用->开放平台

参数说明

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

1

top_org_id

必选

String

学校id

2

org_id

必选

String

班级id

3

page

可选

Int

分页,默认1

4

page_size

可选

Int

数量,默认10,上限100

返回说明

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

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

性别(0:女,1:男,2:未填,3:保密)

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成员)

示例

请求示例
https://gateway.tianyuyun.com/user/openapi/org/get-class-member-list?top_org_id=***&org_id=***&accessToken={{accessToken}}
返回示例
{
    "code": "000000",
    "message": "成功",
    "result": {
        "page": 1,
        "page_size": 10,
        "count": 3,
        "member_list": [
            {
                "user_id": "c55be4f8-6704-11e9-82a9-0200f7699d5b",
                "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": "语文",
                    },
                    {
                        "subject_id": "23",
                        "subject_name": "武术2",
                    }
                ]
            },
            {
                "user_id": "c51b125c-6704-11e9-82a9-0200f7699d5b",
                "name": "yyyy",
                "gender": "2",
                "role_type": "teacher",
                "avatar_list": {
                    "1": "",
                    "2": "",
                    "3": ""
                },
                "create_time": 1554963535,
                "subject": []
            },
            {
                "user_id": "8d23c4ce-666f-11e9-944a-0200f74753a1",
                "name": "xxxx",
                "gender": "2",
                "role_type": "teacher",
                "avatar_list": {
                    "1": "",
                    "2": "",
                    "3": ""
                },
                "create_time": 1554963535,
                "subject": []
            }
        ]
    },
    "_timestamp": "1559131523.8804",
    "_runtime": "0.0747"
}