Группы

Получение групп

GET/api/v2/groups/

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
search	string	поиск.
offset	integer	указывает число строк, которое необходимо пропустить в общем массиве данных
limit	integer	ограничивает количество выходных данных
objectId	integer	поиск по идентификатору объекта.

Ответ:
Ключ	Тип	Описание
result	object	объект,содержащий ответ от сервера
result	array	массив полученных групп
id	integer	идентификатор записи
title	string	номер группы в системе
user_id	integer	идентификатор партнёра
object_id	integer	идентификатор объекта
name	string	имя группы
description	string	описание группы
entrance	integer	номер подъезда
total_cameras	integer	общее количество камер
total_users	integer	общее количество пользователей
count	integer	общее количество записей
success	boolean	информация о статусе запроса

POST/api/v2/objects/{id}/manage/groups/add

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
description	string	описание
entrance	integer	номер подъезда (передается если тип группы – entrance)
name	string	имя группы
groupType	string	тип группы. Возможные значения - entrance,any
id	integer	идентификатор объекта(передается в url)

Ответ:
Ключ	Тип	Описание
success	boolean	информация о статусе запроса

POST/api/v2/groups/{id}/manage

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
id	integer	идентификатор группы
description	string	описание группы
entrance	integer	номер подъезда (передается только если группа подъездная)
name	string	имя группы (передается только если группа не подъездная)

Ответ:
Ключ	Тип	Описание
success	boolean	информация о статусе запроса

POST/api/v2/distribution/access-rights/add

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
camerasId	array	массив идентификаторов камеры, от 1 до 1000 элементов
usersId	array	массив идентификаторов пользователей, от 1 до 1000 элементов
groupsId	integer	массив идентификаторов групп
page	string	обязательный параметр, требуемое значение group

Ответ:
Ключ	Тип	Описание
success	boolean	информация о статусе запроса

POST/api/v2/group/{id}/add-cam-user-for-group/{type}

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
id	integer	идентификатор группы
type	string	тип добавления (user или camera)
camerasId	array	массив идентификаторов камер, от 1 до 1000 элементов
usersId	array	массив идентификаторов пользователей, от 1 до 1000 элементов

Ответ:
Ключ	Тип	Описание
success	boolean	информация о статусе запроса

POST/api/v2/group/{id}/delete-cam-user-for-group/{type}

Заголовки:
Ключ	Тип	Описание
x-vsaas-api-key	string	Api Key пользователя
x-vsaas-session	string	Session key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-key	string	Token, сгенерированный в личном кабинете

Параметры:
Ключ	Тип	Описание
id	integer	идентификатор группы
type	string	тип удаления (user или camera)
camerasId	array	массив идентификаторов камер, от 1 до 1000 элементов
usersId	array	массив идентификаторов пользователей, от 1 до 1000 элементов

Ответ:
Ключ	Тип	Описание
success	boolean	информация о статусе запроса

Api

Серверы

Api

Объекты

Содержание