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

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

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

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

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

Наименование параметра Тип Формат Обязательность Описание
token string 40-символов о Токен авторизации
version integer Неотрицательное целое число Версия данных
Если значение не указано или указано "0" - берется актуальная версия.
activeOnly boolean true/false Параметр для возвращения активных адресных элементов
Если значение не указано или указано "false" - возвращаются все данные.
Если указано "true" - возвращаются только активные элементы.

Ответы

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

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

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

Переменная Тип Описание
level integer Уровень вложенности типа элемента
name string Наименование уровня
isActive boolean Признак активности
Если указано "true" - тип элемента активен (не устарел).

Примеры

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

    https://data.pbprog.ru/api/address/levels?token=123abcde123abcde123adcde123abcde123abcde&activeOnly=true

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

    {
        "level": 1,
        "name": "Субъект РФ",
        "isActive": true
    }