Отримання списку районів

URI: /api/v2/insurance/address?region_id={region_id}&district={district}

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

Важливо!

Використовуються дані, отримані методом Отримання списку областей

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

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

Параметри URI

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

Ім'я	Тип	Обов'язковий	Опис
region_id	string	Так	Ідентифікатор області, отриманий методом Отримання списку областей
district	string	Так	Початкові літери назви району для пошуку

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

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

інформація

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

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

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

200 OK

Відповідь: /api/v2/insurance//address?region_id=285&district=Ніж

{
    "data": [
        {
            "region": {
                "id": "285",
                "name": "Чернігівська"
            },
            "district": {
                "id": "415",
                "name": "Ніжинський"
            }
        }
    ]
}

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

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

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