VenueStates

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

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

Endpoints

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

Получение списка всех помещений и их текущих статусов

type

нет

VenueState[]

venues:readAny

http://localhost/api/v1/venuestates

GET

Получение статуса помещения

key

нет

VenueState

venues:readAny

http://localhost/api/v1/venuestates/C2-205 (получить статус помещения C2- 205)

POST

Подписка на изменение статусов помещений

Параметры подписки

venues:readAny

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

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

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

string
нет

name

Тип помещения (desk и т. д.)

string
нет

http://localhost/api/v1/venuestates?type=desk (получение списка всех рабочих мест и их текущих статусов)

Параметры URL

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

_id помещения в коллекции venues (совпадает с _id в коллекции venuestates)

string