Группы

Пример curl-запроса на получение списка групп из объекта:

curl --location --requetstGET 'http://cloud.dvor24.com/api/v2/groups?objectId=ID-ОБЪЕКТА' --header 'X-Vsaas-Api-Key: КЛЮЧ-API' --header 'X-Vsaas-Session: ТОКЕН-АВТОРИЗАЦИИ'

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

GET/api/v2/groups/

Заголовки:
КлючТипОписание
x-vsaas-api-keystringApi Key пользователя
x-vsaas-sessionstringSession key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-keystringToken, сгенерированный в личном кабинете
Параметры:
КлючТипОписание
searchstringпоиск.
offsetintegerуказывает число строк, которое необходимо пропустить в общем массиве данных
limitintegerограничивает количество выходных данных
objectIdintegerпоиск по идентификатору объекта.
Ответ:
КлючТипОписание
resultobjectобъект,содержащий ответ от сервера
successbooleanинформация о статусе запроса

Добавление группы

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

Заголовки:
КлючТипОписание
x-vsaas-api-keystringApi Key пользователя
x-vsaas-sessionstringSession key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-keystringToken, сгенерированный в личном кабинете
Параметры:
КлючТипОписание
descriptionstringописание
entranceintegerномер подъезда (передается если тип группы – entrance)
namestringимя группы
groupTypestringтип группы. Возможные значения - entrance,any
idintegerидентификатор объекта(передается в url)
Ответ:
КлючТипОписание
successbooleanинформация о статусе запроса

Редактирование группы

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

Заголовки:
КлючТипОписание
x-vsaas-api-keystringApi Key пользователя
x-vsaas-sessionstringSession key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-keystringToken, сгенерированный в личном кабинете
Параметры:
КлючТипОписание
idintegerидентификатор группы
descriptionstringописание группы
entranceintegerномер подъезда (передается только если группа подъездная)
namestringимя группы (передается только если группа не подъездная)
Ответ:
КлючТипОписание
successbooleanинформация о статусе запроса

Распределение камер по группам

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

Заголовки:
КлючТипОписание
x-vsaas-api-keystringApi Key пользователя
x-vsaas-sessionstringSession key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-keystringToken, сгенерированный в личном кабинете
Параметры:
КлючТипОписание
camerasIdarrayмассив идентификаторов камеры, от 1 до 1000 элементов
usersIdarrayмассив идентификаторов пользователей, от 1 до 1000 элементов
groupsIdintegerмассив идентификаторов групп
pagestringобязательный параметр, требуемое значение group
Ответ:
КлючТипОписание
successbooleanинформация о статусе запроса

Добавление камер и пользователей в группу

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

Заголовки:
КлючТипОписание
x-vsaas-api-keystringApi Key пользователя
x-vsaas-sessionstringSession key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-keystringToken, сгенерированный в личном кабинете
Параметры:
КлючТипОписание
idintegerидентификатор группы
typestringтип добавления (user или camera)
camerasIdarrayмассив идентификаторов камер, от 1 до 1000 элементов
usersIdarrayмассив идентификаторов пользователей, от 1 до 1000 элементов
Ответ:
КлючТипОписание
successbooleanинформация о статусе запроса

Удаление камер и пользователей из группы

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

Заголовки:
КлючТипОписание
x-vsaas-api-keystringApi Key пользователя
x-vsaas-sessionstringSession key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-keystringToken, сгенерированный в личном кабинете
Параметры:
КлючТипОписание
idintegerидентификатор группы
typestringтип удаления (user или camera)
camerasIdarrayмассив идентификаторов камер, от 1 до 1000 элементов
usersIdarrayмассив идентификаторов пользователей, от 1 до 1000 элементов
Ответ:
КлючТипОписание
successbooleanинформация о статусе запроса

Api

Серверы

Api

Объекты