API для Мобильного приложения

Разработчикам / REST API для BOOCO Meteor (v 1.x) / Специальные версии API

В данном разделе приведено API, которое сделано для мобильного приложения.

Endpoints

Endpoint
Метод
Описание
Queries
Body (JSON)
Значение поля data
Права (ресурс)
Версия
GET

Получить список бронирований для текущего пользователя (где он является организатором). К результату добавляется статусы доступных действий.

startDateendDatevenueType

UserBookingEvent[]

read:own (booking)

1.36.2

GET

Получает бронирование по :eventId. Предполагается, что организатор - текущий пользователь (иначе будет выдана ошибка). К результату добавляются статусы доступных действий.

UserBookingEvent

read:own (booking)

1.36.2

Параметры запроса (Queries)

Queries
Описание
Тип значения
Обязательный
Значение по умолчанию

Начальная дата поиска событий в колелкции bookings.

TDateISO
нет

 Конечная дата поиска событий в коллекции bookings.

TDateISO
нет

Тип помещения, для которого запрашивается событие (meeting-room, class, и др). Может быть один тип или несколько. Если несколько, то они указываются, через запятую: venueType=meeting-room,class.

string
нет

Параметры URL

Name
Описание
Тип значения

_id события в коллекции bookings.

string

Используемые типы

type EventStatus =
  'unknown' | // Если другие статусы не подходят (Не должно быть таких ситуаций)
  'scheduled' | // Событие запланировано
  'removed' | // Событие удалено
  'in-progress-booked' | // Событие, но пользователь не сделал check-in
  'in-progress' | // Событие началась и пользователь сделал check-in или check-in не требуется
  'finished'; // Событие закончилось

type UserBookingEvent = Omit<BookingEvent, 'sync'> & {
	timezone?: string, // Часовой поясв помещения
  eventStatus: EventStatus; // Текущий статус события
  canUpdate: boolean, // Пользователь может обновить мероприятие
  canDelete: boolean, // Пользователь может удалить мероприятие
  canFinish: boolean, // Пользователь может заврешить мероприятие
  canCheckin: boolean, // Пользователь может сделать checkin
  canCheckout: boolean // Пользователь может сделать checkout
};