根据分类编码查询用户组接口
业务场景
可以使用「根据分类编码查询用户组接口」查询用户组基本信息（不包含子组信息）。
接口说明
目前接口仅支持通过用户组分类编码作为查询条件进行查询。
接口限制
1. 10次/秒;
2. 分页接口，每一页最多100条。
接口地址
根据分类编码查询用户组接口
/api/openapi/usergroup/list
请求类型
POST
请求参数
| 参数名称 |
类型 |
是否必填 |
说明 |
| offset |
int |
否 |
当前页首条数据在所有数据中的偏移量，默认值0。例如：若pageSize=100，下一次offset=100，以此类推 |
| pageSize |
int |
否 |
查询 指定 条数，默认为 50，最大为100 |
| bizCode |
int |
是 |
用户组的分类编码 |
参数样例
{
"offset":0,
"pageSize":50,
"bizCode":"UGC2003311ICH7DA8"
}
响应参数
参数说明
| 参数名 |
类型 |
描述 |
| total |
int |
记录总数 |
| offset |
int |
当前页首条数据在所有数据中的偏移量 |
| pageSize |
int |
查询 指定 条数 |
| list |
List<UserGroup> |
返回用户组列表 |
用户组 (UserGroup)
| 参数名 |
类型 |
描述 |
| bizCode |
String |
用户组编码 |
| name |
String |
用户组名称 |
| nameEn |
String |
用户组英文名称 |
| comment |
String |
用户组描述 |
| affiliatedCompanyList |
List<Company> |
用户组所属公司（待上线） |
用户组所属公司 （Company）
| 参数名 |
类型 |
描述 |
| bizCode |
String |
所属公司的编码 |
| name |
String |
所属公司名称 |
参数样例
- 正常响应参数示例
{
"code": "ACK",
"message": "成功",
"data": {
"total": 4,
"offset": 0,
"pageSize": 50,
"list": [
{
"bizCode": "UG2004031E697PXC",
"name": "哈哈哈",
"nameEn": "hahaha",
"comment": "大哥大",
"affiliatedCompanyList": [
{
"bizCode": "00001",
"name": "公司1"
}
]
},
{
"bizCode": "UG2004271F2QE1E9",
"name": "老王",
"nameEn": "laowang",
"comment": "大哥大",
"affiliatedCompanyList": [
{
"bizCode": "00001",
"name": "公司1"
}
]
},
{
"bizCode": "UG2004271F2QE1EB",
"name": "哈士奇",
"nameEn": "haShiQiDog",
"comment": "大哥大",
"affiliatedCompanyList": [
{
"bizCode": "00001",
"name": "公司1"
}
]
}
],
"hasNextPage": false
},
"errorCode": null,
"success": true
}
- 错误返回示例
{
"code": "NACK",
"message": "查询失败！",
"data": null,
"success": false
}
修改记录
2022-01-19 新增