Vehicles

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

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

Endpoint	Метод	Описание	Queries	Body (JSON)	Результат (data)	Права (ресурс)	Версия	Комментарий
/vehicles	GET	Получение списка всех транспортных средств	type	нет	`Vehicles[]`	vehicle: readAny
/vehicles/:id	GET	Получение информации о транспортном средстве	key	нет	`Vehicle`	vehicle: readAny		Транспортные средства могут не иметь свойства `name`, поэтому нужно указывать `key`
/vehicles/:id	DELETE	Удаление транспортного средства	key	нет		vehicle:deleteAny		Транспортные средства могут не иметь свойства `name`, поэтому нужно указывать `key`
/vehicles/	POST	Добавление транспортного средства		Информация о транспортном средстве (в формате JSON)	`Vehicle`	vehicle:createAny
/vehicles/:id	PUT	Редактирование транспортного средства	key	Информация о транспортном средстве, которое нужно изменить (в формате JSON)	`Vehicle` (все или выборочные поля)	vehicle:updateAny		Транспортные средства могут не иметь свойства `name`, поэтому нужно указывать `key`
/vehicles/subscribe/	POST	Подписка на изменения		`SubscriptionInfo<Vehicle>`	Параметры подписки	vehicle: readAny

Queries	Описание	Тип значения	Обязательный	Значение по умолчанию	Комментарий
key	Определяет, по какому полю делается запрос. Формат: `key=<name>` или `key=<_id>`	string	нет	`name`
type	Тип транспортного средства (`vip` и т. д.)	string	нет		Пример: http://localhost/api/v1/vehicles?type=vip (получение списка всех VIP транспортных средств)

Name	Описание	Тип значения
id	Имя транспортного средства или значение ключевого поля, если используется параметр `key`	string