Старые endpoint’ы

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

Общие параметры при запросах

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

Максимальное число записей в выдаче. Формат: limit=<number>

number
нет

100

/api/v1/venues?limit=10 (вывести 10 элементов)

Количество элементов, которые нужно пропустить при выдаче. Формат: skip=<number>

number
нет

0

/api/v1/venues?skip=10&limit=10 (пропустить первые 10 элементов и вывести следующие 10 элементов)

Определяет, по какому полю делается запрос. Формат: key=<name> или key=<_id>

string
нет

name

/api/v1/venues/12345678?key=_id (запрос помещения с внутренним id=12345678)

Дополнительные параметры поиска, которые можно использовать при запросах, предполагающих поиск в базе данных. Формат: key1=value1&key2=value2... (key1, key2 —названия полей, value1 и value2 — их значения в формате строки или в виде JSON-объекта)

string
нет

Пример 1: /api/v1/venues?type=meeting-room (найти все помещения с типом = meeting-room). Пример 2: /api/v1/bookings?removed={"$ne":true} (найти все бронирования (кроме удаленных) с полем removed, которое не равно true). Пример 3: /api/v1/equipment?name=["display1", "display2"] (отобразить информацию по устройствам с именами display1 и display2)

Общее API (старые endpoint’ы)

/api/v1/acl/*

Методы для работы с ACL

ACL

/api/v1/calsystems/*

Методы для работы с календарными системами

Calsystems

/api/v1/equipment/*

Методы для работы с оборудованием

Equipment

/iridium

Команды для интеграции с панелями бронирования и управления

Iridium

/api/v1/media/*

Методы для работы с медиаконтентом

Media

/api/v1/triggers/*

Методы для работы с триггерами

Triggers

/api/v1/variable/*

Описание пользовательских переменных variable и их значений

Variable

/api/v1/venues/*

Методы для работы с помещениями

Venues

/api/v1/bookings/*

Методы для работы с бронированиями

Bookings

/api/v1/eqstates/*

Методы для работы с оборудованием (получение обратных связей)

Eqstates

/api/v1/info/*

Метод для получения информации о сервере

Info

/api/v1/log/*

Методы для работы с Журналом событий

Log

/api/v1/script/*

Методы для управления скриптами

Script

/api/v1/users/*

Методы для работы с пользователями

Users

/api/v1/vehicles/*

Методы для работы со списком транспортных cредств, который используется для раздела Парковки

Vehicles

/api/v1/venuestates/*

Методы для получения статусов помещений

VenueStates