Метод для получения списка регионов РФ
Метод позволяет получить список регионов РФ.
Адрес: http://data.pbprog.ru/api/address/regions?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хх | Произошла внутренняя ошибка сервиса |
Описание ответа
В качестве ответа возвращается массив элементов, структура которых представлена ниже.
Переменная | Тип | Описание |
---|---|---|
regionCode | string | Код региона |
objectGuid | string | GUID региона |
name | string | Наименование |
typeName | string | Сокращенное название типа региона |
fullTypeName | string | Полное название типа региона |
kladr | string | Код КЛАДР |
okato | string | Код ОКАТО |
oktmo | string | Код ОКТМО |
postIndex | string | Почтовый индекс |
Примеры
Пример запроса:
http://data.pbprog.ru/api/address/regions?token=123abcde123abcde123adcde123abcde123abcde&activeOnly=false
Пример ответа:
{
"regionCode":"01",
"objectGuid":"d8327a56-80de-4df2-815c-4f6ab1224c50",
"name":"Адыгея",
"typeName":"Респ",
"fullTypeName":"Республика",
"kladr":"0100000000000",
"okato":"79000000000",
"oktmo":"79000000",
"postIndex":"385000"
}