Список пользователей для событий и реакций
Пагинированный список пользователей, которые будут получать реакции. Включает в себя суб-пользователей и родительского пользователя
GET/api/v1/scripts/usersHeaders |
Authorization | Bearer token |
Accept | application/json |
X-Client | ios-cctv|android-cctv|thick-legal|web |
X-UUID | unique device id |
Body |
pagerequired | int | Номер страницы пагинации |
per_pagerequired | int | Количество элементов в одной странице пагинации. По умолчанию 25 штук |
exclude_users_idsrequired | array | Массив id пользователей. Исключенные id не будут отражены в выдаче. |
Response |
|
200 | Возвращает список пользователей на i странице пагинации |
JSON
{
"data": [
{
"id": 55,
"login": "user@mail.com",
"name": "user",
"parent_id": 3,
"created_at": "2021-12-16 18:14:50",
"updated_at": "2022-06-17 12:04:06",
"access_token_id": null,
"can_update_password": false
}
],
"links": {
"first": "https://vms.local/api/v3/scripts/users?page=1",
"last": "https://vms.local/api/v3/scripts/users?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "pagination.previous",
"active": false
},
{
"url": "https://vms.local/api/v3/scripts/users?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "pagination.next",
"active": false
}
],
"path": "https://vms.local/api/v3/scripts/users",
"per_page": 25,
"to": 1,
"total": 1
}
}
|
|
401 | Токен авторизации не передан или не валидный, см. Получение токена |
|
422 | Возвращает JSON объект с ошибкой, см. Валидация |
JSON
{
"message": "Тут не будет информативного сообщения",
"errors": {
"any_key": [
"Тут будет описана причина ошибки"
]
}
}
|
Пример |
JSON
curl -k --location --request GET 'https://vms.local/api/v1/scripts/users?page=int&per_page=int&exclude_users_ids=array' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'
|
