Отримання списку населених пунктів

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

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

Важливо!

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

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

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

Параметри URI

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

Ім'я	Тип	Обов'язковий	Опис
region_id	string	Так	Ідентифікатор області, отриманий методом Отримання списку областей
district_id	string	Так	Ідентифікатор району, отриманий методом Отримання списку районів
city	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.city	object	Дані про знайдений населений пункт
data.city.id	string	Ідентифікатор населеного пункту
data.city.name	string	Назва населеного пункту

інформація

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

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

200 OK

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

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