#############################################################
**Отримання списку ролей**
#############################################################

Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edin.ua/uk/latest/API_DOCflow/Methods/Authorization.html>`__ .

+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
|                       **Метод запиту**                       |                                                **HTTP GET**                                                |
+==============================================================+============================================================================================================+
| **Content-Type**                                             | application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)                                 |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **URL запиту**                                               |   **https://doc.edin.ua/bdoc/roles**?status=1&company_id=1307&limit=30                                     |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації |
|                                                              |                                                                                                            |
|                                                              | **Опціональні url-параметри (фільтр)**                                                                     |
|                                                              |                                                                                                            |
|                                                              | **search_pattern** - пошук по назві ролі                                                                   |
|                                                              |                                                                                                            |
|                                                              | **limit** - ліміт вибірки (за замовчуванням=20)                                                            |
|                                                              |                                                                                                            |
|                                                              | **offset** - зміщення відносно верхньої межі вибірки (за замовчуванням=0)                                  |
|                                                              |                                                                                                            |
|                                                              | **company_id** - id компанії                                                                               |
|                                                              |                                                                                                            |
|                                                              | **status** - статус ролі (0-всі; 1-активні; 2-заблоковані)                                                 |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+

**JSON-параметри в тілі HTTP запиту/відповіді**
*******************************************************************

``REQUEST``

В цьому методі json-тіло **запиту** відсутнє (інші дані передавати не потрібно).

``RESPONSE``

В рядку заголовка (Header) додатково передається кількість знайдених ролей за запитом, наприклад:

.. code:: ruby

    count: 100500

Опис json-параметрів **відповіді** метода API (об'єкт **Role**)

Таблиця 3 - Опис параметрів об'єкта **Role**

.. csv-table:: 
  :file: for_csv/Role.csv
  :widths:  1, 12, 41
  :header-rows: 1
  :stub-columns: 0

--------------

**Приклади**
*****************

**При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)**

--------------

Приклад тіла **відповіді** (json): 

.. code:: ruby

	[
	  {
	    "roleId": 3425,
	    "company": {
	      "companyId": 1307,
	      "accountId": 8,
	      "type": 1,
	      "name": "Для ролей ",
	      "code": "43343",
	      "isApproved": 0,
	      "isSignedOffer": 1,
	      "isActive": 1,
	      "ownershipType": "vccv",
	      "uuid": "7ef5b288-537f-4efd-b175-5993ed2438e3",
	      "certificates": [],
	      "dictionaries": [],
	      "notifySettings": []
	    },
	    "companyId": 1307,
	    "name": "Сахар",
	    "code": "c64a655f76a5404d8d1391e9517abbb0",
	    "status": 1,
	    "autoBind": 0,
	    "users": [],
	    "uiTypes": [],
	    "packageAccessType": 0
	  }
	]