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

URI: /api/v2/insurance/address?region={назва_регіону}

Метод використовується для пошуку та отримання списку областей України за початковими літерами назви.

Запит виконується методом GET.

⚠️ Запит повинен містити заголовок Accept: application/json

Параметри URI

Метод дозволяє передати в рядку запиту наступні параметри:

Ім'я	Тип	Обов'язковий	Опис
region	string	Так	Початкові літери назви області для пошуку (наприклад: Чер)

Параметри відповіді

Ім'я	Тип	Опис
data	list[object]	Перелік знайдених областей
data.region	object	Дані конкретної області
data.region.id	string	Ідентифікатор області
data.region.name	string	Повна назва області

інформація

Отриманий параметр data.region.id використовується як фільтр для наступного кроку — методу Отримання списку районів

Приклади відповіді

Приклад успішної відповіді

200 OK

Відповідь: /api/v2/insurance/address?region=Чер

{
    "data": [
        {
            "region": {
                "id": "283",
                "name": "Черкаська"
            }
        },
        {
            "region": {
                "id": "284",
                "name": "Чернівецька"
            }
        },
        {
            "region": {
                "id": "285",
                "name": "Чернігівська"
            }
        }
    ]
}

Приклад неуспішної відповіді

Відповідь: 400 Bad Request

{
    "message": "Не найдено"
}