根据用户组查询子组接口
业务场景
可以使用「根据用户组查询子组接口」查询用户组子组的编码列表。
接口说明
目前接口支持通过用户组编码作为查询条件进行查询该用户组下面的子组,为分页查询。
接口限制
1. 10次/秒;
2. 分页接口,每一页最多100条。
接口地址
根据用户组编码查询用户组子组接口
/api/openapi/usergroup/sub/list
请求类型
POST
请求参数
参数名称 |
类型 |
是否必填 |
说明 |
pageNo |
int |
否 |
要查询数据的页码,从1开始计数,默认值1。 |
pageSize |
int |
否 |
查询 指定 条数,默认为 50,最大为100 |
userGroupBizCode |
int |
是 |
用户组的编码 |
参数样例
{
"pageNo": 1,
"pageSize": 50,
"userGroupBizCode": "UGC2003311ICH7DA8"
}
响应参数
参数说明
参数名 |
类型 |
描述 |
hasNextPage |
boolean |
是否有后面的页 |
list |
List<SubUserGroup> |
返回用户组子组列表 |
用户组 (SubUserGroup)
参数名 |
类型 |
描述 |
userGroupBizCode |
String |
用户组编码 |
bizCode |
String |
用户组子组编码 |
isDefault |
boolean |
是否为默认子组 |
参数样例
- 正常响应参数示例
{
"code": "ACK",
"message": "成功",
"data": {
"hasNextPage": false,
"list": [
{
"userGroupBizCode": "UG2004031E697PXC",
"bizCode": "UG2112061LIKPQTO_"
},
{
"userGroupBizCode": "UG2004031E697PXB",
"bizCode": "UG2112061LIKPQT1"
},
{
"userGroupBizCode": "UG2004031E697PXD",
"bizCode": "UG2112061LIKPQT2"
}
]
},
"errorCode": null,
"success": true
}
- 错误返回示例
{
"code": "NACK",
"message": "用户组[UG2112061LIKPQTO1]不存在",
"data": null,
"errorCode": "USER_GROUP_NOT_EXISTED",
"success": false
}
errorCode 说明
编码 |
说明 |
USER_GROUP_NOT_EXISTED |
用户组不存在 |
修改记录
2023-09-19 新增