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

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

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

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

Наименование параметра	Тип	Формат	Обязательность	Описание
guid	string	guid	о	GUID объекта
token	string	40-символов	о	Токен авторизации
version	integer	Неотрицательное целое число		Версия данных Если значение не указано или указано "0" - берется актуальная версия.
roomNumber	string			Номер комнаты, если требуется получить адрес для комнаты
roomType	string			Тип комнаты. Указывается только если указан roomNumber
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	Полное название типа элемента

Возможные значения переменной - level

Значение	Описание
1	Субъект РФ
2	Административный район
3	Муниципальный район
4	Сельское/городское поселение
5	Город
6	Населенный пункт
7	Элемент планировочной структуры
8	Элемент улично-дорожной сети
9	Земельный участок
10	Здание (сооружение)
11	Помещение
12	Помещение в пределах помещения
13	Уровень автономного округа (устаревшее)
14	Уровень внутригородской территории (устаревшее)
15	Уровень дополнительных территорий (устаревшее)
16	Уровень объектов на дополнительных территориях (устаревшее)
17	Машино-место

Примеры

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

    http://data.pbprog.ru/api/address/full-address/d8892970-e385-48ae-b540-e002f4506d75?token=123abcde123abcde123adcde123abcde123abcde

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

    {
        "value":"Кировская обл, г Киров, ул Московская, д. 110, к. 1",
        "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":"f363f4f8-85fa-4ca2-b1c7-f4da16af0b8c",
                "name":"Московская",
                "typeName":"ул",
                "fullTypeName":"Улица",
                "level":8,
                "kladr":"43000001000029200",
                "okato":"33401000000",
                "oktmo":"33701000",
                "isActive":true
            },
            {
                "objectGuid":"d8892970-e385-48ae-b540-e002f4506d75",
                "name":"110",
                "typeName":"д.",
                "fullTypeName":"Дом",
                "level":10,
                "okato":"33401000000",
                "oktmo":"33701000",
                "postIndex":"610033",
                "isActive":true,
                "sublevels":[
                    {
                        "name":"1",
                        "typeName":"к.",
                        "fullTypeName":"Корпус"
                    }
                ]
            }
        ]
    }