Перейти к содержанию

Метод для получения списка дочерних элементов для элемента с указанным GUID

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

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

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

Наименование параметра Тип Формат Обязательность Описание
guid string guid о GUID объекта
token string 40-символов о Токен авторизации
version integer Неотрицательное целое число Версия данных
Если значение не указано или указано "0" - берется актуальная версия
activeOnly boolean true/false Параметр для возвращения активных адресных элементов
Если значение не указано или указано "false" - возвращаются все данные.
Если указано "true" - возвращаются только активные элементы
hierarchyMode string Режим поиска
Если значение не указано - то поиск осуществляется по административно-территориальному и муниципальному делению.
Если значение "1" или "adm" - по административно-территориальному делению.
Если значение "2" или "mun" - по муниципальному делению.
Если "3" или "both" - по обоим делениям

Ответы

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

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

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

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

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

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

Примеры

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

    http://data.pbprog.ru/api/address/childs/0b940b96-103f-4248-850c-26b6c7296728?token=123abcde123abcde123adcde123abcde123abcde&hierarchyMode=adm

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

    {
        "objectId": 68912611,
        "objectGuid": "dc08f542-f5b8-4f2c-bec5-19c685066f9b",
        "name": "6",
        "typeName": "д.",
        "fullTypeName": "дом",
        "level": 10,
        "kladr": null,
        "okato": "45293566000",
        "oktmo": "45902000",
        "postIndex": "117342",
        "cadastralNumber": "77:06:0008001:1020",
        "isActive": true,
        "addToReestrDate": null,
        "sublevels": [
            {
                "name": "14",
                "typeName": "стр.",
                "fullTypeName": "строение"
            }
        ]
    }