Bookings

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

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

Endpoint	Метод	Описание	Queries	Body (JSON)	Значение поля data	Права (ресурс)	Пример
/bookings	GET	Получить список бронирований из коллекции bookings. ВАЖНО: рекомендуется использовать `/bookings/get`	removed			read:any (booking)	`http://localhost/api/v1/bookings?removed={"$ne":true}` — найти все бронирования (кроме удаленных) с полем `removed`, которое не равно `true`
/bookings/:id	GET	Получение информации о бронировании из коллекции bookings по `:id`. ВАЖНО: необходимо указать параметр `key=_id`	key			read:any (booking)
/bookings/:id	DELETE	Удаление бронирования c `:id` из коллекции bookings. ВАЖНО: необходимо указать параметр `key=_id`. Рекомендуется использовать `api/v1/bookings/remove/:id`	key			delete:any (booking)
/bookings	POST	Добавление новой записи в коллекцию bookings			Информация о бронировании	create:any (booking)
/bookings/:id	PUT	Редактирование бронирования из коллекции bookings по `:id`. Возвращается обновленный элемент. ВАЖНО: необходимо указать параметр `key=_id`	key	Указываются поля, которые нужно обновить	Информация о бронировании	update:any (booking)
/bookings/get	GET	Список бронирований с информацией о помещении	venuestartendremoved			read:any (booking)
/bookings/today	GET	Список сегодняшних бронирований	venueremovedvenues			read:any (booking)
/bookings/today	POST	Список сегодняшних бронирований	venueremovedvenues			read:any (booking)
/bookings/upcoming	GET	Список предстоящих бронирований (включая текущие). Примечание. Отображаются только предстоящие события. По умолчанию удаленные события (флаг `removed = true`) не отображаются	venuedaysremoved			read:any (booking)
/bookings/add	POST	Добавляет новое бронирование с проверкой времени следующей встречи. Если время следующей встречи раньше времени завершения новой встречи, то время обрезается. При добавлении бронирования добавляются поля `venueType` и `venueName`	venueIdstartenddurationsubjectorganizer		Данные в формате JSON	create:own (booking)create:any (booking)(см. замечание*)
/bookings/finish/:id	GET	Завершает текущее бронирование `:id`	reason			update:any (booking)
/bookings/remove/:id	GET	Удаляет бронирование `:id` (пометить как удаленное)	reason			delete:any (booking)
/bookings/confirm/:id	GET	Подтверждение бронирования	reason			update:any (booking)
/bookings/subscribe/	POST	Подписка на изменения		`<SubscriptionInfoBookings>`	Параметры подписки	read:any (booking)

* При проверке прав, если email пользователя = полю organizer события, то используется право *:own, иначе — *:any.

Queries	Описание	Тип значения	Обязательный	Значение по умолчанию	Пример
key	Определяет, по какому полю делается запрос. Формат: `key=<name>` или `key=<_id>`	string	нет	`name`
venue	id помещения, для которого требуется отображать события	string	нет
/bookings/get/start	Начальная дата периода для поиска в коллекции bookings		нет
/bookings/get/end	Конечная дата периода для поиска в коллекции bookings		нет
/bookings/add/start	Время начала встречи. Если не задано, используется текущее время (формат — ISO Date string)	ISO Date string	да
/bookings/add/end	Время завершения встречи (end или duration должно быть задано) (формат — ISO Date string)	ISO Date string	да
/bookings/add/duration	Период встречи в миллисекундах (`end` или `duration` должно быть задано)	number	да
subject	Тема встречи	string	да
organizer	Email организатора встречи	string	да
/bookings/get/removed	Значение флага `removed`. По умолчанию не отображаются удаленные бронирования. Примечание. Отображаются все события, удовлетворяющие условиям запроса. Добавляются поля `venueName` и `venueType`	json	нет

/bookings/today/removed	Значение флага `removed`. По умолчанию не отображаются удаленные бронирования	json	нет
/bookings/upcoming/removed	Значение флага `removed`. Добавляются поля `venueName` и `venueType`	json	нет		`http://localhost/api/v1/bookings/upcoming?venue=cnf.8.02&days=1` (показать предстоящие на сегодня события для помещения cnf.8.02). Комментарий: отображаются только предстоящие события. По умолчанию удаленные события (флаг `removed = true`) не отображаются.
venues	Фильтр для отбора помещений. Примечание. Отображаются все события за сегодняшний день. Добавляются поля `venueName` и `venueType`	json	нет		`http://localhost/api/v1/bookings/today`, данные: `{ "venues": { "groups": "group1", "type": "meeting-room" } }` — получить список сегодняшних бронирований для всех переговорных комнат, которые относятся к группе `group1`
days	Количество дней вперед, за которые нужно отображать события (для `/bookings/upcoming`)	number	нет
venueId	id помещения	string	нет
reason	Причина (для `/bookings/confirm/:id`). Причина завершения бронирования (для `/bookings/finish/:id`). Причина удаления бронирования (для `/bookings/remove/:id`). Если не указана, то используется строка `REST API`	string	нет

Name	Описание	Тип значения
id	id события	string