Отримання списку користувачів¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP GET |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
URL запиту |
https://doc.edi-n.com/bdoc/users?status=0&limit=30 |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Опціональні url-параметри (фільтр) search_pattern - пошук по ПІБ та email limit - ліміт вибірки (за замовчуванням=20) offset - зміщення відносно верхньої межі вибірки (за замовчуванням=0) status - статус користувача (0-всі; 1-активний; 2-заблокований) |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).
RESPONSE
В рядку заголовка (Header) додатково передається кількість знайдених користувачів за запитом, наприклад:
count: 100500
Опис json-параметрів відповіді метода API (масив об’єктів User)
Таблиця 3 - Опис параметрів об’єкта User
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт User |
||
userId |
long |
ID користувача |
accountId |
long |
ID аккаунта |
String |
email та логін користувача |
|
password |
String |
пароль користувача |
isOwner |
int |
ознака власника аккаунта; 0 - ні, 1 - так |
isCaptcha |
Integer |
ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна) |
fio |
String |
ПІБ користувача |
tel |
String |
телефон |
companies |
List<Company_> |
масив об’єктів; компанії |
account |
об’єкт; дані облікового запису |
|
status |
int |
статус користувача («1» - активний; «2» - заблокований) |
roles |
List<Role_> |
масив об’єктів; ролі |
routes |
List<PackageRoute_> |
масив об’єктів; маршрути |
passSecureType |
int |
рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий) |
passPolicyId |
long |
id пральний політики, застосованої до користувача |
userInfo |
об’єкт; інформація про користувача |
|
lastLoginIp |
String |
IP-адреса останнього входу |
lastLoginDate |
long |
дата останнього входу |
uiTypes |
List<UIType2Role_> |
масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей |
Приклади¶
При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)
Приклад тіла відповіді (json):
[
{
"userId": 473,
"accountId": 8,
"email": "test@test33232",
"isOwner": 0,
"isCaptcha": 1,
"fio": "test test ",
"companies": [],
"status": 1,
"roles": [],
"routes": [],
"passSecureType": 2,
"passPolicyId": 282,
"lastLoginIp": "0.0.0.0",
"lastLoginDate": 0,
"uiTypes": [],
"userAccess": {}
},
{
"userId": 479,
"accountId": 8,
"email": "fds@dfsfs.ua",
"isOwner": 0,
"isCaptcha": 1,
"fio": "43343",
"companies": [],
"status": 1,
"roles": [],
"routes": [],
"passSecureType": 2,
"passPolicyId": 282,
"lastLoginIp": "0.0.0.0",
"lastLoginDate": 0,
"uiTypes": [],
"userAccess": {}
},
{
"userId": 475,
"accountId": 8,
"email": "dfsmaelgern@gfldnbskjngb",
"isOwner": 0,
"isCaptcha": 1,
"fio": "xfzvb dfgb ",
"companies": [],
"status": 2,
"roles": [],
"routes": [],
"passSecureType": 2,
"passPolicyId": 282,
"lastLoginIp": "0.0.0.0",
"lastLoginDate": 0,
"uiTypes": [],
"userAccess": {}
}
]