Метод для получения списка вариантов адреса (GET)
Метод позволяет получить список вариантов полного адреса объекта по указанному приблизительному тексту.
Адрес: https://data.pbprog.ru/api/address/full-address/parse?token={token}&addressText={addressText}&resultLimit={resultLimit}&version={version}&hierarchyMode={hierarchyMode}
Тип: GET
Content-Type: application/json
Авторизация: требуется
Соединение с БД: требуется
Описание входных параметров
| Наименование параметра | Тип | Формат | Обязательность | Описание |
|---|---|---|---|---|
| token | о | Токен авторизации | ||
| addressText | string | о | Приблизительное описание адреса. Описание может представлять собой: текстовое описание; GUID ФИАС; код КЛАДР; почтовый индекс. |
|
| resultLimit | integer | Максимальное количество вариантов в ответе. Максимальное значение - 100. Если значение не указано или указано меньше 1, то считается равным 10. |
||
| version | integer | Неотрицательное целое число | Версия данных Если значение не указано или указано "0" - берется актуальная версия. |
|
| hierarchyMode | string | Режим поиска Если значение не указано - то поиск осуществляется по административно-территориальному делению. Если значение "1" или "adm" - по административно-территориальному делению. Если значение "2" или "mun" - по муниципальному делению. |
Ответы
| Код ответа | Описание |
|---|---|
| 200 | Запрос успешно обработан |
| 400 | Некорректный запрос |
| 401 | В запросе отсутствует токен, или токен неверного формата, или в запросе указан несуществующий токен |
| 5хх | Произошла внутренняя ошибка сервиса |
Описание ответа
В качестве ответа возвращается массив элементов, структура которых представлена ниже.
| Переменная | Тип | Описание |
|---|---|---|
| value | string | Адрес |
| addressParts | array | Массив с детальной информацией по элементам адреса |
Структура элементов массива - addressParts
| Переменная | Тип | Описание |
|---|---|---|
| objectGuid | string | GUID объекта |
| name | string | Наименование |
| typeName | string | Сокращенное название типа элемента |
| fullTypeName | string | Полное название типа элемента |
| level | integer | Уровень вложенности типа элемента |
| kladr | string | Код КЛАДР |
| okato | string | Код ОКАТО |
| oktmo | string | Код ОКТМО |
| postIndex | string | Почтовый индекс |
| isActive | boolean | Признак активности Если указано "true" - тип элемента активен (не устарел). |
| sublevels | array | Дополнительный уровень вложенности типа элемента |
Структура элементов массива - sublevels
| Переменная | Тип | Описание |
|---|---|---|
| name | string | Наименование |
| typeName | string | Сокращенное название типа элемента |
| fullTypeName | string | Полное название типа элемента |
Примеры
Пример запроса:
https://data.pbprog.ru/api/address/full-address/parse?token=123abcde123abcde123adcde123abcde123abcde&addressText=Киров,%20Ленина,%20113
Пример ответа:
[
{
"value": "Калужская обл, Кировский р-н, г Киров, ул Ленина, д 113",
"addressParts": [
{
"objectGuid": "18133adf-90c2-438e-88c4-62c41656de70",
"name": "Калужская",
"typeName": "обл",
"fullTypeName": "область",
"level": 1,
"kladr": "4000000000000",
"okato": "29000000000",
"oktmo": "29000000",
"isActive": true
},
{
"objectGuid": "bd20192d-2702-4d5f-bd0c-7db4df7be215",
"name": "Кировский",
"typeName": "р-н",
"fullTypeName": "район",
"level": 2,
"isActive": true
},
{
"objectGuid": "7c875ac0-5c75-4798-8786-564ccb5bd9f2",
"name": "Киров",
"typeName": "г",
"fullTypeName": "город",
"level": 5,
"kladr": "4001100100000",
"okato": "29214501000",
"oktmo": "29614101001",
"isActive": true
},
{
"objectGuid": "3ebd4a60-3f08-4d89-83a8-1f0feaea4760",
"name": "Ленина",
"typeName": "ул",
"fullTypeName": "улица",
"level": 8,
"kladr": "40011001000005200",
"okato": "29214501000",
"oktmo": "29614101001",
"postIndex": "249440",
"isActive": true
},
{
"objectGuid": "7db78665-c605-45b9-8d74-ea5e3fc0176b",
"name": "113",
"typeName": "д",
"fullTypeName": "дом",
"level": 10,
"okato": "29214501000",
"oktmo": "29614101001",
"postIndex": "249440",
"isActive": true
}
]
},
{
"value": "Кировская обл, г Киров, ул Ленина, з/у 113",
"addressParts": [
{
"objectGuid": "0b940b96-103f-4248-850c-26b6c7296728",
"name": "Кировская",
"typeName": "обл",
"fullTypeName": "область",
"level": 1,
"kladr": "4300000000000",
"okato": "33000000000",
"oktmo": "33000000",
"postIndex": "610000",
"isActive": true
},
{
"objectGuid": "452a2ddf-88a1-4e35-8d8d-8635493768d4",
"name": "Киров",
"typeName": "г",
"fullTypeName": "город",
"level": 5,
"kladr": "4300000100000",
"okato": "33401000000",
"oktmo": "33701000001",
"isActive": true
},
{
"objectGuid": "2e4036dd-58ba-4723-8e0c-a9b82735a342",
"name": "Ленина",
"typeName": "ул",
"fullTypeName": "улица",
"level": 8,
"kladr": "43000001000022500",
"okato": "33401000000",
"oktmo": "33701000001",
"isActive": true
},
{
"objectGuid": "6acd3f52-d7e4-4969-9a28-14765ea510aa",
"name": "113",
"typeName": "з/у",
"fullTypeName": "земельный участок",
"level": 9,
"okato": "33401000000",
"oktmo": "33701000001",
"isActive": true
}
]
},
{
"value": "Кировская обл, г Киров, ул Ленина, д 113",
"addressParts": [
{
"objectGuid": "0b940b96-103f-4248-850c-26b6c7296728",
"name": "Кировская",
"typeName": "обл",
"fullTypeName": "область",
"level": 1,
"kladr": "4300000000000",
"okato": "33000000000",
"oktmo": "33000000",
"postIndex": "610000",
"isActive": true
},
{
"objectGuid": "452a2ddf-88a1-4e35-8d8d-8635493768d4",
"name": "Киров",
"typeName": "г",
"fullTypeName": "город",
"level": 5,
"kladr": "4300000100000",
"okato": "33401000000",
"oktmo": "33701000001",
"isActive": true
},
{
"objectGuid": "2e4036dd-58ba-4723-8e0c-a9b82735a342",
"name": "Ленина",
"typeName": "ул",
"fullTypeName": "улица",
"level": 8,
"kladr": "43000001000022500",
"okato": "33401000000",
"oktmo": "33701000001",
"isActive": true
},
{
"objectGuid": "ede4530a-b2ba-4ec3-a977-3ae7647132c4",
"name": "113",
"typeName": "д",
"fullTypeName": "дом",
"level": 10,
"okato": "33401000000",
"oktmo": "33701000001",
"postIndex": "610002",
"isActive": true
}
]
}
]