Skip to content

Класс: Адрес (address)

Apostol Developer edited this page May 12, 2022 · 8 revisions

API

POST /api/v1/address/[ type | method | count | set | get | list ]

Конечные точки классов

Параметры запроса

Имя Тип Значение Описание
id UUID Обязательный для действия изменить. Идентификатор объекта.
parent UUID Необязательный. Идентификатор объекта родителя.
type STRING Необязательный. Код типа.
code STRING Рекомендуемый. Код: ФФ СС РРР ГГГ ППП УУУУ. Где: ФФ - код страны; СС - код субъекта РФ; РРР - код района; ГГГ - код города; ППП - код населенного пункта; УУУУ - код улицы.
index STRING Рекомендуемый. Почтовый индекс.
country STRING Рекомендуемый. Страна.
region STRING Рекомендуемый. Регион.
district STRING Рекомендуемый. Район.
city STRING Рекомендуемый. Город.
settlement STRING Рекомендуемый. Населённый пункт.
street STRING Рекомендуемый. Улица.
house STRING Рекомендуемый. Дом.
building STRING Рекомендуемый. Корпус.
structure STRING Рекомендуемый. Строение.
apartment STRING Рекомендуемый. Квартира.
address STRING Рекомендуемый. Полный адрес в виде строки.

Формат ответа

Поле Тип Описание
code STRING Код КЛАДР (ФФ СС РРР ГГГ ППП УУУУ).
index STRING Почтовый индекс.
country STRING Страна.
region STRING Регион.
district STRING Район.
city STRING Город.
settlement STRING Населённый пункт.
street STRING Улица.
house STRING Дом.
building STRING Корпус.
structure STRING Строение.
apartment STRING Квартира.
address STRING Полный адрес.

Описание code:

ФФ СС РРР ГГГ ППП УУУУ
Код страны Код субъекта РФ Код района Код города Код населенного пункта Код улицы

Адрес в виде строки

POST /api/v1/address/get/string

Возвращает адрес в виде строки.

Параметры запроса:

Имя Тип Значение Описание
id UUID Обязательный. Идентификатор объекта.
Clone this wiki locally