开发文档-天喻教育云开放平台

用户信息接口

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

1、获取组织成员列表7.0

基础需要授权

根据组织编号获取组织成员简单列表

前置条件

获取接口访问凭证：accessToken

请求说明

url	https://gateway.tianyuyun.com/user/openapi/user/get-org-member-simple-list?top_org_id=c2d2a224-5a9a-11e9-9c82-0200f7b88099&page=1&page_size=10&accessToken={{accessToken}}
请求方式	get
是否需要鉴权	是
请求数限制	否
接口方向	第三方应用->开放平台

参数说明

序号	字段名	约束	类型	说明
1	top_org_id	可选	string	机构、学校等组织编号（top_org_id、org_id、top_school_id不能同时为空）
2	org_id	可选	string	部门、校区、班级等单节点编号（top_org_id、org_id、top_school_id不能同时为空），支持复合值，用半角逗号分隔（复合查询时需要传递机构编号）
3	org_recursion	可选	int	是否包含下级节点成员，0:不包含（默认），1:包含所有下级，org_id须为单值
4	top_school_id	可选	string	校区编号，查校区及其下属所有节点的数据（top_org_id、org_id、top_school_id不能同时为空）
6	name	可选	string	姓名
7	user_type	可选	int	用户类型，0:学生，1:老师，2:家长，3:工作人员，4:机构人员，5:企业人员，12:市民（支持复合值，用半角逗号分隔，例如：0,1）不支持家长类型
7	need_type	可选	string	额外需要返回的类型（dep部门节点,edu班级节点,family学生家长数据,多个使用,逗号分隔）
8	page	可选	int	页码
9	page_size	可选	int	每页条数，默认10，最大500条

返回说明

序号	字段名	约束	类型	说明
1	code	必选	string	结果编码
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	user_type	必选	string	成员类型
3.4.3	name	必选	string	成员姓名
3.4.4	user_org	可选	json数组	部门、班级列表信息，设置need_type时返回
3.4.4.1	org_id	必选	string	部门、班级id
3.4.4.2	org_type	必选	string	节点类型("1": "机构","2": "学校","3": "校区","4": "部门","5": "学段","6": "年级","7": "班级","8": "企业机构","9": "教学工作室","10": "平台")
3.4.5	user_family	可选	json数组	学生的家长信息，设置need_type时返回
3.4.5.1	family_id	必选	string	家长用户id
3.4.5.2	family_name	必选	string	家长的称谓(xx的妈妈)

示例

请求示例
https://gateway.tianyuyun.com/user/openapi/user/get-org-member-simple-list?accessToken={{accessToken}}&top_org_id=c2d2a224-5a9a-11e9-9c82-0200f7b88099&page=1&page_size=10
返回示例
{
  "code": "000000",
  "message": "请求成功",
  "result": {
    "page": 1,
    "page_size": 10,
    "count": 3,
    "member_list": [
      {
        "user_id": "b4c63e54-5a9d-11e9-a503-0200f757af5f",
        "user_type": "1",
        "name": "xxx"
      },
      {
        "user_id": "805a9c00-5a9d-11e9-976d-0200f757af5f",
        "user_type": "1",
        "name": "yyy"
      },
      {
        "user_id": "af144ae4-5a9a-11e9-9c82-0200f7b88099",
        "user_type": "1",
        "name": "zzz"
      }
    ]
  }
}

开发者登录

1、获取组织成员列表7.0

前置条件

请求说明

参数说明

返回说明

示例