主题
分页查询用户组内成员
- 本接口可以返回任意类型的用户组下的用户
- 用户组下的成员支持搜索
接口说明
请求URL:http[s]://{网关地址}/minos-platform/group/searchUser
请求方式: POST
请求内容类型: application/json
响应内容类型: application/json
请求说明
请求体
| 字段名 | 参数名 | 是否必填 | 类型 | 描述 |
|---|---|---|---|---|
| 用户组id | groupId | M | String | 用户组编码 |
| 搜索关键字 | searchKey | O | String | 搜索关键字(学工号、姓名)模糊 |
| 查询的当前页 | pageNumber | M | int | 用于分页查询使用,从1开始 |
| 查询的每页数量 | pageSize | M | int | 用户分页查询使用,默认10,最大允许100 |
请求示例
{
"groupId":"gp001",
"searchKey":"1",
"pageNumber":"1",
"pageSize":"20"
}1
2
3
4
5
6
2
3
4
5
6
响应说明
响应体
数据格式:
JSON
| 字段名 | 参数名 | 是否必填 | 类型 | 描述 |
|---|---|---|---|---|
| 返回码 | errcode | M | String | 返回码,0 成功,其他为错误 |
| 返回码描述 | errmsg | M | Sring | 返回码描述 |
| 查询的当前页 | pageNumber | M | int | 用于分页查询使用,从1开始 |
| 查询的每页数量 | pageSize | M | int | 用户分页查询使用,默认10,最大允许100 |
| 查询的总条数 | totalSize | M | long | 查询的总条数 |
| 用户组中的用户 | data | O | List<GroupUser> | 查询到的当前页用户 |
| 字段名 | 参数名 | 是否必填 | 类型 | 描述 |
|---|---|---|---|---|
| 用户名(学工号) | userId | M | String | 用户名/学工号,最大20个字符 |
| 用户姓名 | userName | M | String | 用户姓名,最大200个字符 |
| 身份分类名称 | categoryName | M | String | 身份分类名称 |
| 手机号 | phone | O | String | 手机号,如果需要国际手机号请使用+86153xxxx7182的格式 |
| 性别 | sexCode | O | String | 0 男 1 女 |
响应示例
json
{
"errcode": "0",
"errmsg": "操作成功",
"pageNumber": 1,
"pageSize": 20,
"totalSize": 2,
"data": [
{
"userId": "newUserWxt1",
"userName": "newUserWxt",
"categoryName": null,
"phone": "***********",
"sexCode": "0"
},
{
"userId": "newUserWxt",
"userName": "newUserWxt",
"categoryName": null,
"phone": "***********",
"sexCode": "0"
}
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
错误码
| 错误码 | 描述 |
|---|---|
| 111001 | 必填参数不能为空 |
| 111002 | 请求参数格式错误 |
| 111009 | 用户组id不存在 |
Demo
java
// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID, APP_SECRET);
// 创建请求对象
GroupUserSearchRequest request = new GroupUserSearchRequest();
request.setGroupId("1146814684774965248");
request.setPageSize(100);
request.setPageNumber(1);
BaseResponse response = client.execute(request);
//调用成功,则处理业务逻辑
if (response.isSuccess()) {
//.....
}1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13

