Метод для получения списка вариантов адреса (POST)
Метод позволяет получить список вариантов полного адреса объекта по указанному приблизительному тексту.
Адрес: https://data.pbprog.ru/api/address/full-address/parse
Тип: POST
Content-Type: application/json
Авторизация: требуется
Соединение с БД: требуется
Описание заголовков
| Ключ заголовков | Тип | Обязательность | Описание |
|---|---|---|---|
| Authorization | string | о | Для передачи токена авторизации |
Описание тела запроса
| Наименование параметра | Тип | Формат | Обязательность | Описание |
|---|---|---|---|---|
| query | string | о | Приблизительное описание адреса. Описание может представлять собой: текстовое описание; GUID ФИАС; код КЛАДР; почтовый индекс. |
|
| count | integer | Максимальное количество вариантов в ответе. Максимальное значение - 100. Если значение не указано или указано меньше 1, то считается равным 10. |
||
| version | integer | Неотрицательное целое число | Версия данных Если значение не указано или указано "0" - берется актуальная версия. |
|
| hierarchyMode | string | Режим поиска Если значение не указано - то поиск осуществляется по административно-территориальному делению. Если значение "1" или "adm" - по административно-территориальному делению. Если значение "2" или "mun" - по муниципальному делению. |
Ответы
| Код ответа | Описание |
|---|---|
| 200 | Запрос успешно обработан |
| 400 | Некорректный запрос |
| 401 | В запросе отсутствует токен, или токен неверного формата, или в запросе указан несуществующий токен |
| 5хх | Произошла внутренняя ошибка сервиса |
Описание ответа
В качестве ответа возвращается массив элементов, структура которых представлена ниже.
| Переменная | Тип | Описание |
|---|---|---|
| value | string | Адрес одной строкой |
| unrestricted_value | string | Адрес одной строкой (полный, с индексом) |
| data | array | Массив с детальной информацией по элементам адреса |
Структура элементов массива - data
| Переменная | Тип | Описание |
|---|---|---|
| postal_code | string | Индекс |
| region_fias_id | string | Код ФИАС региона |
| region_kladr_id | string | Код КЛАДР региона |
| region_with_type | string | Регион с типом |
| region_type | string | Тип региона (сокращенный) |
| region_type_full | string | Тип региона |
| region | string | Регион |
| area_fias_id | string | Код ФИАС района в регионе |
| area_kladr_id | string | Код КЛАДР района в регионе |
| area_with_type | string | Район в регионе с типом |
| area_type | string | Тип района в регионе (сокращенный) |
| area_type_full | string | Тип района в регионе |
| area | string | Район в регионе |
| city_fias_id | string | Код ФИАС города |
| city_kladr_id | string | Код КЛАДР города |
| city_with_type | string | Город с типом |
| city_type | string | Тип города (сокращенный) |
| city_type_full | string | Тип города |
| city | string | Город |
| city_district_fias_id | string | Код ФИАС района города (заполняется, только если район есть в ФИАС) |
| city_district_kladr_id | string | Код КЛАДР района города (не заполняется) |
| city_district_with_type | string | Район города с типом |
| city_district_type | string | Тип района города (сокращенный) |
| city_district_type_full | string | Тип района города |
| city_district | string | Район города |
| settlement_fias_id | string | Код ФИАС населенного пункта |
| settlement_kladr_id | string | Код КЛАДР населенного пункта |
| settlement_with_type | string | Населенный пункт с типом |
| settlement_type | string | Тип населенного пункта (сокращенный) |
| settlement_type_full | string | Тип населенного пункта |
| settlement | string | Населенный пункт |
| street_fias_id | string | Код ФИАС улицы |
| street_kladr_id | string | Код КЛАДР улицы |
| street_with_type | string | Улица с типом |
| street_type | string | Тип улицы (сокращенный) |
| street_type_full | string | Тип улицы |
| street | string | Улица |
| house_fias_id | string | Код ФИАС дома |
| house_kladr_id | string | Код КЛАДР дома |
| house_type | string | Тип дома (сокращенный) |
| house_type_full | string | Тип дома |
| house | string | Дом |
| block_type | string | Тип корпуса/строения (сокращенный) |
| block_type_full | string | Тип корпуса/строения |
| block | string | Корпус/строение |
| flat_type | string | Тип квартиры (сокращенный) |
| flat_type_full | string | Тип квартиры |
| flat | string | Квартира |
| fias_id | string | Код ФИАС квартиры |
| fias_level | string | Уровень детализации, до которого адрес найден в ФИАС |
| fias_actuality_state | string | Признак актуальности адреса в ФИАС |
| kladr_id | string | Код КЛАДР |
| okato | string | Код ОКАТО |
| oktmo | string | Код ОКТМО |
| Код | Описание |
|---|---|
| 0 | Страна |
| 1 | Регион |
| 3 | Район |
| 4 | Город |
| 5 | Район города |
| 6 | Населенный пункт |
| 7 | Улица |
| 8 | Дом |
| 65 | Планировочная структура |
| -1 | Иностранный или пустой |
| Код | Описание |
|---|---|
| 0 | Актуальный |
| null | Не определен |
Примеры
Пример запроса:
Заголовок запроса:
Authorization: Token 123abcde123abcde123adcde123abcde123abcde
Тело запроса:
{
"query": "Киров, Ленина, 113"
"count": 10
}
Пример ответа: 1
{
"suggestions": [
{
"value": "Калужская обл, Кировский р-н, г Киров, ул Ленина, д 113",
"unrestricted_value": "249440, Калужская обл, Кировский р-н, г Киров, ул Ленина, д 113",
"data": {
"postal_code": "249440",
"country": "Россия",
"country_iso_code": "RU",
"federal_district": null,
"region_fias_id": "18133adf-90c2-438e-88c4-62c41656de70",
"region_kladr_id": "4000000000000",
"region_iso_code": null,
"region_with_type": "Калужская обл",
"region_type": "обл",
"region_type_full": "область",
"region": "Калужская",
"area_fias_id": "bd20192d-2702-4d5f-bd0c-7db4df7be215",
"area_kladr_id": null,
"area_with_type": "Кировский р-н",
"area_type": "р-н",
"area_type_full": "район",
"area": "Кировский",
"city_fias_id": "7c875ac0-5c75-4798-8786-564ccb5bd9f2",
"city_kladr_id": "4001100100000",
"city_with_type": "г Киров",
"city_type": "г",
"city_type_full": "город",
"city": "Киров",
"city_area": null,
"city_district_fias_id": null,
"city_district_kladr_id": null,
"city_district_with_type": null,
"city_district_type": null,
"city_district_type_full": null,
"city_district": null,
"settlement_fias_id": null,
"settlement_kladr_id": null,
"settlement_with_type": null,
"settlement_type": null,
"settlement_type_full": null,
"settlement": null,
"street_fias_id": "3ebd4a60-3f08-4d89-83a8-1f0feaea4760",
"street_kladr_id": "40011001000005200",
"street_with_type": "ул Ленина",
"street_type": "ул",
"street_type_full": "улица",
"street": "Ленина",
"house_fias_id": "7db78665-c605-45b9-8d74-ea5e3fc0176b",
"house_kladr_id": null,
"house_type": "д",
"house_type_full": "дом",
"house": "113",
"block_type": null,
"block_type_full": null,
"block": null,
"entrance": null,
"floor": null,
"flat_fias_id": null,
"flat_type": null,
"flat_type_full": null,
"flat": null,
"flat_area": null,
"square_meter_price": null,
"flat_price": null,
"postal_box": null,
"fias_id": "7db78665-c605-45b9-8d74-ea5e3fc0176b",
"fias_code": null,
"fias_level": "8",
"fias_actuality_state": "0",
"kladr_id": null,
"geoname_id": null,
"capital_marker": null,
"okato": "29214501000",
"oktmo": "29614101001",
"tax_office": null,
"tax_office_legal": null,
"timezone": null,
"geo_lat": null,
"geo_lon": null,
"beltway_hit": null,
"beltway_distance": null,
"metro": null,
"qc_geo": "5",
"qc_complete": null,
"qc_house": null,
"history_values": null,
"unparsed_parts": null,
"source": null,
"qc": null
}
},
...
]
}
-
Все неописанные переменные, которые формируются в ответе, не заполняются, то есть равны null. ↩