Отримання списку будинків та поштових індексів

URI: /api/v2/insurance/address?street_id={street_id}

Метод використовується для пошуку та отримання повного переліку номерів будинків та відповідних їм поштових індексів для обраної вулиці.

Важливо!

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

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

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

Параметри URI

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

Ім'я	Тип	Обов'язковий	Опис
street_id	string	Так	Ідентифікатор вулиці, отриманий методом Отримання списку вулиць

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

Ім'я	Тип	Опис
data	list[object]	Дані про будинки
data.house	object	Дані про конкретний будинок
data.house.number	string	Номер будинку (може містити літери, наприклад "1А")
data.house.postcode	string	Поштовий індекс, закріплений за цим будинком

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

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

200 OK

Відповідь: /api/v2/insurance/address?street_id=50222

{
    "data": [
        {
            "house": {
                "number": "1А",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "1",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "2Г",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "2Д",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "3",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "4",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "5",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "5А",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "6Б",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "6А",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "6",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "7",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "7А",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "8",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "9",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "9А",
                "postcode": "07300"
            }
        },
        {
            "house": {
                "number": "11",
                "postcode": "07300"
            }
        }
    ]
}

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

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

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