Отримання списку вулиць

URI: /address?region_id={region_id}&district_id={district_id}&city_id={city_id}&street={street}

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

Важливо!

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

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

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

Параметри URI

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

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

інформація

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

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

200 OK

Відповідь: /api/v2/insurance/address?region_id=285&district_id=415&city_id=28681&street=Шевчен

{
    "data": [
        {
            "region": {
                "id": "285",
                "name": "Чернігівська"
            },
            "district": {
                "id": "415",
                "name": "Ніжинський"
            },
            "city": {
                "id": "28681",
                "name": "Ніжин"
            },
            "street": {
                "id": "120301",
                "name": "Шевченка"
            }
        },
        {
            "region": {
                "id": "285",
                "name": "Чернігівська"
            },
            "district": {
                "id": "415",
                "name": "Ніжинський"
            },
            "city": {
                "id": "28681",
                "name": "Ніжин"
            },
            "street": {
                "id": "120223",
                "name": "Шевченка МПС"
            }
        }
    ]
}