############################################################# **Отримання списку користувачів** ############################################################# Для роботи з цим методом користувач повинен бути `авторизованим `__ . +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | **Метод запиту** | **HTTP GET** | +==============================================================+============================================================================================================+ | **Content-Type** | application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) | +--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | **URL запиту** | **https://doc.edin.ua/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) додатково передається кількість знайдених користувачів за запитом, наприклад: .. code:: ruby count: 100500 Опис json-параметрів **відповіді** метода API (масив об'єктів **User**) Таблиця 3 - Опис параметрів об'єкта **User** .. csv-table:: :file: for_csv/User.csv :widths: 1, 12, 41 :header-rows: 1 :stub-columns: 0 -------------- **Приклади** ***************** **При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)** -------------- Приклад тіла **відповіді** (json): .. code:: ruby [ { "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": {} } ]