开发文档-重庆中小学智慧教育平台开放平台

用户信息接口7.0

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

1获取组织成员列表7.0

1、获取组织成员列表7.0

基础需要授权

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

前置条件

获取接口访问凭证：accessToken

请求说明

url	https://opengate-basic.cq.smartedu.cn/user/openapi/user/get-org-member-simple-list?accessToken={{accessToken}}&top_org_id=c2d2a224-5a9a-11e9-9c82-0200f7b88099&page=1&page_size=10
请求方式	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	need_type	可选	string	额外需要返回的类型（dep部门节点,edu班级节点,family学生家长数据,多个使用,逗号分隔）
7	user_type	可选	int	用户类型，0:学生，1:老师，2:家长，3:工作人员，4:机构人员，5:企业人员，12:市民（支持复合值，用半角逗号分隔，例如：0,1）不支持家长类型
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://opengate-basic.cq.smartedu.cn/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	msgType	必选	String	10	消息类型，此时固定为：text
1.1	text	必选	Json	-	text消息体
1.1.1	content	必选	String		消息内容

参数说明

请求参数消息体-link类

序号	字段名	约束	类型	长度	说明
1	msgType	必选	String	10	消息类型，此时固定为：link
2	link	必选	Json	-	link消息体
2.1	pcUrl	必选	String		PC端消息点击链接地址
2.2	appUrl	必选	String		移动客户端点击消息时跳转到的H5地址
2.3	title	必选	String		消息标题
2.4	busiId	必选	String		对应业务的id
2.5	content	必选	String		消息描述
2.6	picUrl	必选	String		图文消息的图片链接，支持JPG、PNG格式，较好的效果为大图640320，小图8080。如不填，在客户端不显示图片

示例

{
	"msgtype": "link",
	"link": {
		"pcUrl": "http://www.baidu.com",
		"appUrl": "http://www.baidu.com",
		"picUrl": "http://xxx.yyy.com/zzz.jpg",
		"content": "百度一下",
		"title": "百度",
		"busiId":"AQWER1234"
	}
}

参数说明

请求参数消息体-oa类

序号	字段名	约束	类型	长度	说明
1	msgType	必选	String	10	消息类型，此时固定为：oa
2	busiId	必选	String	-	该条oa消息在业务系统对应的id
3	pcUrl	必选	String		消息点击链接地址
4	appUrl	必选	String		移动客户端点击消息时跳转到的H5地址
5	oa	必选	Json	-	oa类型消息体
5.1	head	必选	Json	255	消息头部Json
5.1.1	text	必选	String	255	消息的头部标题
5.1.2	bgColor	可选	String		消息头部的背景颜色。长度限制为8个英文字符，其中前2为表示透明度，后6位表示颜色值。不要添加0x。默认值：FFCC0000
5.2	body	可选	Json		消息体
5.2.1	title	可选	String		消息体的标题
5.2.2	content	可选	String		消息体的正文
5.2.3	imageUrl	可选	String		消息体中的图片url
5.2.4	fileCount	可选	String		自定义的附件数目。此数字仅供显示，不作验证
5.2.5	author	可选	String		自定义的作者名字
5.2.6	form	可选	Json数组		消息体的表单，最多6个
5.2.7	key	可选	String		消息体的关键字
5.2.8	value	可选	String		消息体的关键字对应的值

开发者登录

1、获取组织成员列表7.0

前置条件

请求说明

参数说明

返回说明

示例

参数说明

示例

参数说明

示例

参数说明