-
Notifications
You must be signed in to change notification settings - Fork 1
Адрес объекта
Alien Ufo edited this page Jun 21, 2022
·
3 revisions
Объекту можно указать почтовый адрес.
POST /api/v1/object/addressПолучить или установить почтовый адрес объекта.
Параметры запроса:
| Имя | Тип | Значение | Описание |
|---|---|---|---|
| id | UUID | Обязательный. Идентификатор объекта. | |
| addresses | JSON array | null OR json | Вариативный. Массив JSON объектов с адресами. |
Формат addresses:
| Ключ | Тип | Описание |
|---|---|---|
| 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 | Необязательный. Полный адрес. |
ВНИМАНИЕ: Если значение id не указано или равно null, то будет создан новый почтовый адрес, иначе изменён.
ВНИМАНИЕ: Если значение addresses не указано или равно null, то метод работает как Получить иначе как Установить.
POST /api/v1/object/address/setСвязывает ранее созданный почтовый адрес с объектом.
Параметры запроса:
| Имя | Тип | Значение | Описание |
|---|---|---|---|
| id | UUID | Обязательный. Идентификатор объекта. | |
| address | JSON array | Обязательный. Идентификатор адреса. | |
| datefrom | TIMESTAMP | Необязательный. Дата начала периода. |
POST /api/v1/object/address/getПолучить почтовый адрес объекта.
Параметры запроса:
| Имя | Тип | Значение | Описание |
|---|---|---|---|
| id | UUID | Обязательный. Идентификатор объекта. | |
| fields | JSON array | Необязательный. Массив JSON string полей в таблице, если не указано то запрос вернет все поля. |
POST /api/v1/object/address/listПолучить почтовый адрес объекта в виде списка.
Параметры запроса: Общие параметры запроса для списка