API поверхностей
Общее
Основной хост сайта https://affix-group.ru/
Тестовый хост https://new.affix-group.ru/
Ключ API
Каждый запрос к API обязательно должен сопровождаться передачей авторизационного заголовка с токеном
Поля поверхности
Ключ | Назначение | Описание |
|---|---|---|
code | Код поверхности | |
uuid | UUID поверхности | |
address | Адрес поверхности | |
light | Наличие подсветки | Да/Нет |
size | Размер | |
coords | Координаты | |
side | Сторона | |
description | Описание поверхности | |
city | Город | |
region | Регион | Регион города (например, Краснодарский край) |
format | Тип поверхности | |
formatType | Тип стороны | Статика/Динамика/Диджитал/etc |
duplicate | Дубль | y/n |
dontSearchable | Не участвует в поиске | y/n |
photos | Фотографии | Массив фотографий |
ots | OTS | Число с разделителем дробной части "." |
grp | GRP | Число с разделителем дробной части "." |
same | Поверхности рядом | Массив UUID поверхностей |
direction | Направление | Направление поверхности |
tt | Ссылка на файл с ТТ |
Массив фотографий
Ключ | Описание | Описание |
|---|---|---|
photo | base64 файла | |
name | Название фотографии включая расширение | Допустимые расширения (jpg,png) |
Направление поверхности
В поле направление поверхности передается часть света, на которую ориентирована поверхности. По умолчанию, если ничего не передано, устанавливается значение n, т.е. север
Значение | Описание |
|---|---|
n | С |
nne | ССВ |
ne | СВ |
ene | ВСВ |
e | В |
ese | ВЮВ |
se | ЮВ |
sse | ЮЮВ |
s | Ю |
ssw | ЮЮЗ |
sw | ЮЗ |
wsw | ЗЮЗ |
w | З |
wnw | ЗСЗ |
nw | СЗ |
nw | ССЗ |
Пример тела запроса
Добавление поверхности
Для добавления (создания) поверхности отправляется POST-запрос по адресу /api/board/.
В теле запроса отправляется JSON с полями новой поверхности.
Обновление поверхности
Для обновления поверхности отправляется POST-запрос на один из следующих адресов:
по адресу
/api/board/UUID/, гдеUUIDэто UUID поверхности в базе 1С. Например,/api/board/46fea19e-1326-4d5a-ae15-b997addde4a1/по адресу
/api/board/. Если поверхность с переданным в теле запросаuuidсуществует, то она будет обновлена
В теле запроса отправляется JSON с полями обновленной поверхности.
Установка пометки на удаление
Для установки пометки на удаление поверхности отправляется POST-запрос по адресу /api/board/mark/UUID/, где UUID это код поверхности в базе 1С. Например, /api/board/mark/46fea19e-1326-4d5a-ae15-b997addde4a1/.
Снятие пометки на удаление
Для снятия пометки на удаление поверхности отправляется POST-запрос по адресу /api/board/unmark/UUID/, где UUID это код поверхности в базе 1С. Например, /api/board/unmark/46fea19e-1326-4d5a-ae15-b997addde4a1/.
Удаление поверхности
Для удаления поверхности отправляется DELETE-запрос по адресу /api/board/UUID/, где UUID это код поверхности в базе 1С. Например, /api/board/46fea19e-1326-4d5a-ae15-b997addde4a1/.