开发文档-东西湖区教育云开放平台

学校信息类接口

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

1、学校的教师、学生成员列表

基础需要授权

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

前置条件

获取接口访问令牌：accessToken

请求说明

url	https://api.wuhaneduyun.cn/user/openapi/user/get-org-member-simple-list
请求方式	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不能同时为空）
5	name	可选	string	-	姓名
6	user_type	可选	int	-	用户类型，学生:0 教师:1（支持复合值，用半角逗号分隔，例如：0,1）不支持家长类型
7	need_type	可选	string	-	额外需要返回的类型（dep部门节点,edu班级节点,family学生家长数据,check_multi_org检测多组织数据,多个使用,逗号分隔）
8	page	必选	int	-	页码
9	page_size	必选	int	-	每页条数，默认10，最大500条
10	more_field	可选	string	-	需要额外返回的字段名，多个以半角逗号分隔，可选值（student_staff_id 学生证号,student_class_number 学生班级学号,student_exam_id 学生校内考号,staff_id 职工工号）
11	user_id	可选	string	-	支持复合值，用半角逗号分隔
12	student_exam_id	可选	string	-	学生校内考号,需指定查学生用户类型才能使用

返回说明

序号	字段名	约束	类型	长度	说明
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	-	节点类型 `系统字段说明`
3.4.5	user_family	可选	json数组	-	学生的家长信息，设置need_type时返回
3.4.5.1	family_id	必选	string	-	家长用户id
3.4.5.2	family_name	必选	string	-	家长的称谓(xx的妈妈)
3.4.6	student_type	可选	string	-	学生类别(0:未知, 1:走读生, 2:住校生),学生用户时返回
3.4.7	student_staff_id	可选	string	-	学生证号
3.4.8	student_class_number	可选	string	-	班级学号
3.4.9	is_multi_org	可选	string	-	1是多组织，0否
3.4.10	esn	可选	string	-	可信教育数字身份号(ESN)

示例

**请求示例**
https://api.wuhaneduyun.cn/user/openapi/user/get-org-member-simple-list?top_org_id=xxx&org_id=xxx&user_type=1&page=1&page_size=10&more_field=student_staff_id
**返回示例：**
{
  "code": "000000",
  "message": "请求成功",
  "result": {
    "page": 1,
    "page_size": 10,
    "count": 3,
    "member_list": [
      {
        "user_id": "xxx",
        "user_type": "1",
        "name": "xxx",
        "student_staff_id": "xyxyxy",
        "esn": ""
      },
      {
        "user_id": "xxx",
        "user_type": "1",
        "name": "yyy",
        "student_staff_id": "xyxyxy",
        "esn": ""
      },
      {
        "user_id": "xxx",
        "user_type": "1",
        "name": "zzz",
        "student_staff_id": "xyxyxy",
        "esn": ""
      }
    ]
  }
}

开发者登录

1、学校的教师、学生成员列表

前置条件

请求说明

参数说明

返回说明

示例