Users

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

Данный раздел содержит методы для работы с пользователями.

Endpoint	Метод	Описание	Queries	Body (JSON)	Значение поля data	Права (ресурс)	Версия
/users	GET	Получение списка пользователей из коллекции users	limitskip...query		`User[]`	read:any (user)
/users	POST	Добавляет новую запись в коллекцию users. ВАЖНО: при использовании этого метода не создается пароль, поэтому нужно использовать `/users/create`		`User`		create:any (user)
/users/:id	GET	Получение пользователя из коллекции users по `:id`. ВАЖНО: необходимо указать параметр `key=_id` (по умолчанию ищется по полю name, которого нет в данной коллекции)	key		`User`	read:any (user)
/users/:id	PUT	Обновление данных о пользователе в коллекции users по `:id`. ВАЖНО: необходимо указать параметр `key=_id` (по умолчанию ищется по полю name, которого нет в данной коллекции). ВАЖНО: рекомендуется использовать вместо этого метода `/users/updatePorfile`	key	`User`	`User`	update:any (user)
/users/:id	DELETE	Удаление пользователя из коллекции users по `:id`. ВАЖНО: необходимо указать параметр `key=_id` (по умолчанию ищется по полю name, которого нет в данной коллекции)	key			delete:any (user)
/users/subscribe	POST	Подписка на изменения в коллекции users. (см. описание механизма подписки)		`SubscriptionInfo<User>`		read:any (user)
/users/unsubscribe	POST	Отмена всех подписок для данного `:socketId`		`SubscriptionInfo<User>`		read:any (user)
/users/create	POST	Создает нового пользователя c паролем. `username` и `password` - обязательные поля.			`{username: string, password: string, profile: BoocoUserProfile}`	create:any (user)	1.37.1
/users/updateProfile	PUT	Обновить профиль для текущего пользователя.		`BoocoUserProfile`		update:own (user)
/users/updateProfile/:userId	PUT	Обновить профиль для пользователя `:userId`.		`BoocoUserProfile`		update:any (user)
/users/photo/:id	GET	Получить фотографию пользователя по username или _id. ВАЖНО: указать `key=_id`, чтобы получить по _id. Возвращаются данные без префикса.	key		`base64`	read:any (user)
/users/getPhoto/:id	GET	Получить фотографию пользователя по _id. Не используется key, возвращается значение с `data:image/png;base64` префиксом.			`base64`	read:own (user)read:any (place)
/users/availableResourceTypes	GET	Получить список доступных для бронирования типов помещений для текущего пользователя.			`string[]`
/users/availablePlaces	GET	Получить список доступных для текущего пользователя локаций.			`Place[]`	read:any (place)	1.37.1 - добавлена проверка прав
/users/access/getUserByAccessId/:accessId	GET	Получить пользователя по id карты доступа `:accessId` (если указан time, то с доступом на указанное время). Если пользователь не найден, то возвращается `status = ‘error’`	timeaccessFormat		`User \| null`	read:any (user)

Queries	Описание	Тип значения	Обязательный	Значение по умолчанию
key	Определяет по какому полю делается запрос. В данной коллекции обязательный параметр, за исключением метода `/users/photo/:id`	string	да	name
…query	Можно указать дополнительные поля, которые будут указаны в формате запроса Mongo.		нет
limit	Максимальное число записей в выдаче	number	нет	1000
time	Время, на которое проверяется карта доступа	TDateISO	нет
accessFormat	Тип карты доступа, если указан, то преобразуется в формат, установленный для сервера	IdCardFormatType	нет

Name	Описание	Тип значения
id	Поле по которому идет поиск в коллекции users. в зависимости от key	string
userId	_id пользователя в коллекции users	string
accessId	id карты доступа (поле access)	string