Метод для получения городов

Метод позволяет получить список вариантов полного адреса объекта по указанному приблизительному тексту.

Адрес: https://data.pbprog.ru/api/address/cities?token={token}&nameOrGuid={nameOrGuid}&hierarchyMode={hierarchyMode}
Тип: GET
Content-Type: application/json
Авторизация: требуется
Соединение с БД: требуется

Описание входных параметров

Наименование параметра	Тип	Формат	Обязательность	Описание
token	string	40-символов	о	Токен авторизации
nameOrGuid	string		о	Название города, GUID города или объекта, в котором требуется найти города.
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/cities?token=123abcde123abcde123adcde123abcde123abcde&nameOrGuid=0b940b96-103f-4248-850c-26b6c7296728&hierarchyMode=mun

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

[
    {
        "value": "Кировская обл, г.о. город Киров, г Киров",
        "objectGuid": "452a2ddf-88a1-4e35-8d8d-8635493768d4",
        "length": 3,
        "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": 95242726,
                "objectGuid": "d2b96d5b-fd19-415c-bd5a-2e03a7de908f",
                "name": "город Киров",
                "typeName": "г.о.",
                "fullTypeName": "городской округ",
                "level": 3,
                "kladr": null,
                "okato": null,
                "oktmo": "33701000",
                "postIndex": null,
                "cadastralNumber": null,
                "isActive": true,
                "addToReestrDate": "01.01.2011",
                "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
            }
        ]
    },
    {
        "value": "Кировская обл, г.о. город Вятские Поляны, г Вятские Поляны",
        "objectGuid": "7ad714c1-1136-4c39-84c1-17e15dbc5aab",
        "length": 3,
        "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": 95242507,
                "objectGuid": "6ff0efa1-cd7c-4c4d-a881-10fabe4db3f8",
                "name": "город Вятские Поляны",
                "typeName": "г.о.",
                "fullTypeName": "городской округ",
                "level": 3,
                "kladr": null,
                "okato": null,
                "oktmo": "33704000",
                "postIndex": null,
                "cadastralNumber": null,
                "isActive": true,
                "addToReestrDate": "01.01.2011",
                "sublevels": null
            },
            {
                "objectId": 698126,
                "objectGuid": "7ad714c1-1136-4c39-84c1-17e15dbc5aab",
                "name": "Вятские Поляны",
                "typeName": "г",
                "fullTypeName": "город",
                "level": 5,
                "kladr": "4300800100000",
                "okato": "33404000000",
                "oktmo": "33704000001",
                "postIndex": null,
                "cadastralNumber": null,
                "isActive": true,
                "addToReestrDate": "03.12.2015",
                "sublevels": null
            }
        ]
    },
    ...
]