1. 获取应用内的所有用户
获取应用关联的用户。
请求方式：POST
请求地址：/bospersonnelservice/{appKey}/users/getUsers
1.1. 请求参数：
Headers：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| appKey | string | xb05cd3a35614caa85c0f8f86c58fcc1 | 是 | 应用Key |
SearchParas：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| NULL | NULL | NULL | NULL | NULL |
Body：
application/json：
{
"page": 1,
"per_page": 20,
"sortby": "name # 指定返回结果按照哪个属性排序",
"order": " asc # 排序，asc升序，desc降序",
"name": "xxx #用户名，可选",
"fullName": "xxx #姓名，可选",
"email": "xxx@xx.com #邮箱，可选",
"telephone": "xxx #电话号码，可选",
"active": "xxx #状态，0为未激活，1为已激活，可选",
"userType": "xxx #用户类型，0为普通用户，1为管理员用户，2为代表企业用户，3为内部用户，可选"
}
1.2. 参数说明：
| 参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
|---|---|---|---|---|
| page | int | NULL | 是 | 页码 |
| per_page | int | NULL | 是 | NULL |
| sortby | string | NULL | 否 | 指定返回结果按照哪个属性排序 |
| order | string | NULL | 否 | 排序，asc升序，desc降序 |
| name | string | NULL | 否 | 用户名，可选 |
| fullName | string | NULL | 否 | 姓名，可选 |
| string | NULL | 否 | 邮箱，可选 | |
| telephone | string | NULL | 否 | 电话号码，可选 |
| active | string | NULL | 否 | 状态，0为未激活，1为已激活，可选 |
| userType | string | NULL | 否 | 用户类型，0为普通用户，1为管理员用户，2为代表企业用户，3为内部用户，可选 |
1.3. 正确返回：
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"pageSize": 0,
"currentPage": 1,
"totalCount": 1,
"results": [
{
"id": "3676",
"name": "Tom",
"fullName": "aaa",
"telephone": "18987987797",
"active": "1",
"guser": "3676",
"gtime": "1533123147201",
"userType": "1",
"company": null,
"email": "Tom@163.com",
"contact": null,
"lastLoginTime": "1533632253476",
"registerTime": "1522666462077",
"guid": null,
"myApps": null,
"appCount": null
"xxx":"xxx"//应用库users表中定义的用户扩展属性
}
]
}
}
1.4. 状态码：
| 状态码 | code | message | data | 原因 |
|---|---|---|---|---|
| 400 | PARAMETER_VALID_ERROR | order请求参数校验不通过 | NULL | 参数order值为asc或desc以外的值时 |
| 400 | PARAMETER_VALID_ERROR | status状态不正确 | NULL | 参数active不为null，并且值为1或0以外的值时 |
| 400 | PARAMETER_VALID_ERROR | status用户类型不正确 | NULL | 参数userType不为null，并且值为0、1、2、3以外的值 |
1.5. 注意事项：
暂无注意事项
1.6. 请求示例
请求URL
http://bosgw.bimwinner.com/bospersonnelservice/w8486e2a067e4bdab7630546ad01751a/users/getUsers
Headers
null
Body(application/json)
{
"page": 1,
"per_page": 20
}
正常响应 200
{
"message": "请求处理成功",
"code": "SUCCESS",
"data": {
"pageSize": 20,
"currentPage": 1,
"totalCount": 4,
"results": [
{
"role": [],
"nativeUser": false,
"qqOpenID": "7AED55D536F493EBAA53D658133DBA2C",
"wxUUID": "w8486e2a067e4bdab7630546ad01751a※0.23676966822731993※wx",
"qqUnionID": null,
"company": "盈嘉内部员工123",
"bosclass": "users",
"id": "1527ffadaf8a4f4abae985c67bbd496d",
"email": "",
"key": "1527ffadaf8a4f4abae985c67bbd496d",
"registerTime": "1562145757298",
"org": [],
"wxOpenID": "oEtfZwklSGF2HNUHSFK99J1DDAg0",
"qqUUID": "※0.2100591186159939※qq",
"fullName": "张三",
"active": "1",
"telephone": "12345678910",
"guserType": "0",
"lastLoginTime": "1597997200991",
"wxUnionID": null,
"name": "raojiajun",
"userType": "1"
},
{
"role": [],
"nativeUser": false,
"registerTime": "1597996824681",
"org": [],
"fullName": "111",
"active": "1",
"telephone": "100180",
"guserType": "0",
"name": "111111",
"bosclass": "users",
"userType": "0",
"id": "298813753",
"email": "1@11.com",
"key": "298813753"
},
{
"role": [],
"nativeUser": true,
"qqOpenID": "8145DCBBBD262D8F0D73710533BF1294",
"subscriptionStatus": "1",
"id": "a494b37887574bceb16c56f620fce0f1",
"email": "",
"key": "a494b37887574bceb16c56f620fce0f1",
"creator": "thirdSystem",
"registerTime": "1597129772778",
"subscriptionStartTime": "1597075200000",
"org": [],
"qqUUID": "w8486e2a067e4bdab7630546ad01751a※0.5646525170826018※qq",
"active": "1",
"userModelStorageLimit": 1,
"telephone": "18301139774",
"guserType": "0",
"lastLoginTime": "1597129804411",
"name": "Oa4513",
"appNumberLimit": 1,
"userType": "0",
"subscriptionExpireTime": "1599667200000"
},
{
"role": [],
"gresetPassword": "no",
"nativeUser": true,
"registerTime": "1597994535235",
"org": [],
"fullName": "张三",
"active": "1",
"telephone": "12345678910",
"guserType": "0",
"guser": "users/24a5f120364a43798eba408cd05ec6f5",
"lastLoginTime": "1597994535682",
"name": "rjj123456",
"guid": "94ac2ed5b8094af19fe357395068d4b7",
"bosclass": "users",
"userType": "0",
"id": "94ac2ed5b8094af19fe357395068d4b7",
"email": "12345678@qq.com",
"key": "94ac2ed5b8094af19fe357395068d4b7",
"gcreatetime": "1597994535454"
}
]
}
}