Calsystems

Разработчикам / REST API для BOOCO Meteor (v 1.x) / Общее API

В данном разделе описываются методы для работы с календарными системами.

Endpoint	Метод	Описание	Queries	Body (JSON)	Значение поля data	Права (ресурс)	Версия
/calsystems	GET	Получение списка всех календарных систем		нет	`Calsystems[]`	settings:calsystem:readAny
/calsystems/:id	GET	Получение информации о календарной системе		нет	`Calsystem`	settings:calsystem:readAny
/calsystems/:id	DELETE	Удаление календарной системы		нет		settings:calsystem:deleteAny
/calsystems/	POST	Добавление календарной системы		`Calsystem`	Информация о календарной системе (в формате JSON)	settings:calsystem:createAny
/calsystems/:id	PUT	Редактирование записи календарной системы		`Calsystem`	Информация о календарной системе, которую нужно изменить (в формате JSON)	settings:calsystem:updateAny
/calsystems/subscribe/	POST	Подписка на изменения		`SubscriptionInfo<Calsystem>`	Параметры подписки	settings:calsystem:readAny
/calsystems/resolveName/:name	GET	Поиск пользователя в календарной системе		нет		settings:calsystem:executeAny
/calsystems/getUserList	GET	Получение списка всех пользователей в календарной системе		нет		settings:calsystem:executeAny
/calsystems/getEvent/:id	GET	Получение события по id из коллекции bookings	loadAttachmentstextOnly	нет		venues:readAny

Queries	Описание	Тип значения	Обязательный	Значение по умолчанию	Комментарий
loadAttachments	Загрузка события с вложениями. Если `true` и у события есть вложения, то они будут загружены в формате BASE64	boolean	нет	`false` (событие загружается без вложений)	Пример: `http://localhost/api/v1/calsystems/getEvent/XAsHNk9tRNff7DNLD? loadAttachments=1` (получение события по id из коллекции Bookings с загрузкой вложений в формате BASE64)
textOnly	Формат, в котором передается тело запроса. Если `true`, то тело запроса передается как обычный текст	boolean	нет	`false` (тело запроса передается в формате HTML)	Пример: `http://localhost/api/v1/calsystems/getEvent/XAsHNk9tRNff7DNLD? loadAttachments=false&textOnly=true` (получение события по id из коллекции Bookings без вложений с телом запроса в виде обычного текста)

Name	Описание	Тип значения
/calsystems/:id	Имя календарной системы или значение ключевого поля, если используется параметр `key`	string
name	Имя пользователя, часть имени, email или часть email	string
/calsystems/getEvent/:id	id события из коллекции bookings (событие должно принадлежать помещению, для которого назначена календарная система; если календарная система не назначена или назначено более одной календарной системы, то будет возвращена ошибка)	string