Перейти до основного вмісту

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

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

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

Важливо!

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

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

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

Параметри URI

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

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

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

Ім'яТипОпис
datalist[object]Перелік знайдених об'єктів
data.regionobjectДані про область
data.region.idstringІдентифікатор області
data.region.namestringПовна назва області
data.districtobjectДані про район
data.district.idstringІдентифікатор району
data.district.namestringНазва району
інформація

Отримані параметри 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": "Ніжинський"
}
}
]
}