Метод для получения списка вариантов адреса (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	string	40-символов	о	Токен авторизации
strictSearch	boolean	true / false		Устанавливает поиск по строгому соответствию. Если значение не указано, то по умолчанию false.
addressText	string		о	Приблизительное описание адреса. Описание может представлять собой: текстовое описание; GUID ФИАС; код КЛАДР; почтовый индекс; кадастровый номер.
resultLimit	integer			Максимальное количество вариантов в ответе. Максимальное значение - 100. Если значение не указано или указано меньше 1, то считается равным 10.
version	integer	Неотрицательное целое число		Версия данных Если значение не указано или указано "0" - берется актуальная версия.
hierarchyMode	string			Режим поиска Если значение не указано - то поиск осуществляется по административно-территориальному делению. Если значение "1" или "adm" - по административно-территориальному делению. Если значение "2" или "mun" - по муниципальному делению.

Ответы

Код ответа	Описание
200	Запрос успешно обработан
400	Некорректный запрос
401	В запросе отсутствует токен, или токен неверного формата, или в запросе указан несуществующий токен
5хх	Произошла внутренняя ошибка сервиса

Описание ответа

В качестве ответа возвращается массив элементов, структура которых представлена ниже.

Переменная	Тип	Описание
value	string	Адрес
objectGuid	string	GUID ФИАС объекта
length	integer	Количество элементов addressParts
addressParts	array	Массив с детальной информацией по элементам адреса

Структура элементов массива - addressParts

Переменная	Тип	Описание
objectId	string	ID объекта (служебный для баз ФИАС)
objectGuid	string	GUID объекта
name	string	Наименование
typeName	string	Сокращенное название типа элемента
fullTypeName	string	Полное название типа элемента
level	integer	Уровень вложенности типа элемента
kladr	string	Код КЛАДР
okato	string	Код ОКАТО
oktmo	string	Код ОКТМО
postIndex	string	Почтовый индекс
isActive	boolean	Признак активности Если указано "true" - тип элемента активен (не устарел)
addToReestrDate	string	Дата внесения записи в реестр
sublevels	array	Дополнительный уровень вложенности типа элемента

Структура элементов массива - sublevels

Переменная	Тип	Описание
name	string	Наименование
typeName	string	Сокращенное название типа элемента
fullTypeName	string	Полное название типа элемента

Примеры

Пример запроса:

    https://data.pbprog.ru/api/address/full-address/parse?token=123abcde123abcde123adcde123abcde123abcde&addressText=Киров московская 110

Пример ответа:

[
    {
        "value": "Кировская обл, г Киров, ул Московская, д. 110",
        "objectGuid": "e160aa69-2058-4e95-b0db-adf0805b02a4",
        "length": 4,
        "addressParts": [
            {
                "objectId": 692248,
                "objectGuid": "0b940b96-103f-4248-850c-26b6c7296728",
                "name": "Кировская",
                "typeName": "обл",
                "fullTypeName": "область",
                "level": 1,
                "kladr": "4300000000000",
                "okato": "33000000000",
                "oktmo": "33000000",
                "postIndex": "610000",
                "cadastralNumber": null,
                "isActive": true,
                "addToReestrDate": "15.09.2015",
                "sublevels": null
            },
            {
                "objectId": 692583,
                "objectGuid": "452a2ddf-88a1-4e35-8d8d-8635493768d4",
                "name": "Киров",
                "typeName": "г",
                "fullTypeName": "город",
                "level": 5,
                "kladr": "4300000100000",
                "okato": "33401000000",
                "oktmo": "33701000001",
                "postIndex": null,
                "cadastralNumber": null,
                "isActive": true,
                "addToReestrDate": "16.12.2015",
                "sublevels": null
            },
            {
                "objectId": 694902,
                "objectGuid": "f363f4f8-85fa-4ca2-b1c7-f4da16af0b8c",
                "name": "Московская",
                "typeName": "ул",
                "fullTypeName": "улица",
                "level": 8,
                "kladr": "43000001000029200",
                "okato": "33401000000",
                "oktmo": "33701000001",
                "postIndex": null,
                "cadastralNumber": null,
                "isActive": true,
                "addToReestrDate": "03.02.2016",
                "sublevels": null
            },
            {
                "objectId": 81117017,
                "objectGuid": "e160aa69-2058-4e95-b0db-adf0805b02a4",
                "name": "110",
                "typeName": "д.",
                "fullTypeName": "дом",
                "level": 10,
                "kladr": null,
                "okato": "33401000000",
                "oktmo": "33701000001",
                "postIndex": "610033",
                "cadastralNumber": "43:40:000135:204",
                "isActive": true,
                "addToReestrDate": "18.12.2017",
                "sublevels": null
            }
        ]
    },
    {
        "value": "Кировская обл, г Киров, ул Московская, д. 110/2",
        "objectGuid": "e24f91c3-b0d7-4f5c-aebb-c65038d5525e",
        "length": 4,
        "addressParts": [
            {
                "objectId": 692248,
                "objectGuid": "0b940b96-103f-4248-850c-26b6c7296728",
                "name": "Кировская",
                "typeName": "обл",
                "fullTypeName": "область",
                "level": 1,
                "kladr": "4300000000000",
                "okato": "33000000000",
                "oktmo": "33000000",
                "postIndex": "610000",
                "cadastralNumber": null,
                "isActive": true,
                "addToReestrDate": "15.09.2015",
                "sublevels": null
            },
            {
                "objectId": 692583,
                "objectGuid": "452a2ddf-88a1-4e35-8d8d-8635493768d4",
                "name": "Киров",
                "typeName": "г",
                "fullTypeName": "город",
                "level": 5,
                "kladr": "4300000100000",
                "okato": "33401000000",
                "oktmo": "33701000001",
                "postIndex": null,
                "cadastralNumber": null,
                "isActive": true,
                "addToReestrDate": "16.12.2015",
                "sublevels": null
            },
            {
                "objectId": 694902,
                "objectGuid": "f363f4f8-85fa-4ca2-b1c7-f4da16af0b8c",
                "name": "Московская",
                "typeName": "ул",
                "fullTypeName": "улица",
                "level": 8,
                "kladr": "43000001000029200",
                "okato": "33401000000",
                "oktmo": "33701000001",
                "postIndex": null,
                "cadastralNumber": null,
                "isActive": true,
                "addToReestrDate": "03.02.2016",
                "sublevels": null
            },
            {
                "objectId": 82077961,
                "objectGuid": "e24f91c3-b0d7-4f5c-aebb-c65038d5525e",
                "name": "110/2",
                "typeName": "д.",
                "fullTypeName": "дом",
                "level": 10,
                "kladr": null,
                "okato": "33401000000",
                "oktmo": "33701000001",
                "postIndex": "610033",
                "cadastralNumber": "43:40:000135:203",
                "isActive": true,
                "addToReestrDate": "24.04.2017",
                "sublevels": null
            }
        ]
    },

    ... 
]