list user: 獲取 使用者 資料 12-13 15:16
list user: 獲取 使用者 資料
更新時間:2022-12-13 15:16:10
HTTP Request
POST: manager/user/list
Body Parameters
Parameter | Type | Status | Description |
---|---|---|---|
langCode | string | optional | 語言, langCode=zhGB / zhHK / zhCN |
limit | int | optional | 最大數量 |
page | int | optional | 第幾頁 |
order | object | optional | 排序, 目前只支援單一column排序 |
name | string | required | column name |
direction | string | required | asc / desc |
natural | boolean | required | 開啟自然排序 |
filters | object | optional | |
name | string | optional | |
role | string | optional | ['admin', 'manager', 'officer', 'tenant']取其中之一, 如想獲取多於一個role寫用 |
Response Structure
Parameter | Type | Status | Description |
---|---|---|---|
status | int | required | 0: 成功, 非0: 失敗 |
data | object | optional | |
data | object[] | optional | |
id | int | optional | users.id |
name | string | required | users.name |
string | required | users.email | |
first_name | string | required | users.first_name |
last_name | string | required | users.last_name |
tel | string | required | users.tel |
roles | string[] | required | |
action | object | required | 應用於RJCMS上 |
props | object | required | |
id | int | optional | users.id |
limit | int | required | 最大顯示數量 |
page | int | required | 當前頁數 |
maxPage | int | required | 最大頁數 |
total | int | required | 總數 |
order | object | required | 排序 |
name | string | required | column name |
direction | string | required | ASC / DESC |
filters | object | required |
Example usage
Example #1
POST: manager/user/list
Body
{
"limit": 2,
"page": 1
}
Response(200,status=0)
{
"status": 0,
"data": {
"user": {
"id": 1,
"estate_id": 1,
"name": "admin",
"first_name": "admin",
"last_name": "admin",
"tel": "12345678",
"email": "admin@admin.com",
"created_at": "2021-11-11 09:19:15",
"updated_at": "2021-11-11 09:19:15",
"user_info_id": 1,
"avatar": ""
},
"roles": [
"admin"
],
"permissionNames": [],
"csrf_token": "m0Wrj3lfs7q5XMUknDJEYs8sc3HgRDraZsVeDpXM",
"ext": {
"estate": null,
"building": {
"id": 1,
"user": 2,
"user_name": "manager_1",
"building": 1,
"building_name": "building_1",
"building_title_enHK": "閒靜閣(A座) ",
"building_title_zhHK": "閒靜閣(A座) ",
"building_title_zhCN": "閒靜閣(A座) "
},
"floor": {
"id": 1,
"user": 28,
"user_name": "tenant_7",
"floor": 1,
"floor_name": "floor_1",
"floor_title_enHK": "1/F",
"floor_title_zhHK": "1/F",
"floor_title_zhCN": "1/F"
},
"unit": {
"id": 1,
"user": 22,
"user_name": "tenant_1",
"unit": 1,
"unit_name": "unit_1",
"unit_title_enHK": "101",
"unit_title_zhHK": "101",
"unit_title_zhCN": "101"
}
}
}
}