Объекты

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

curl –location --requestGET 'http://cloud.dvor24.com/api/v2/objects?objectType=MKD' --header 'X-Vsaas-Api-Key: КЛЮЧ-API' --header 'X-Vsaas-Session: ТОКЕН-АВТОРИЗАЦИИ'

Получение объектов

GET/api/v2/objects/

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

Параметры:
Ключ	Тип	Описание
limit	integer	ограничивает количество выходных данных
offset	integer	указывает число строк, которое необходимо пропустить в общем массиве данных
search	string	поиск
objectType	string	тип объекта МКД/произвольный (возможные значения - MKD,arbitrary)

Ответ:
Ключ	Тип	Описание
result	object	объект,содержащий ответ от сервера
result	array	массив объектов
address	string	адрес
title	string	название объекта
time_zone_id	integer	идентификатор часового пояса
cameras_monitoring	boolean	ведётся ли мониторинг камер на объекте
user_id	integer	идентификатор владельца.
gps	string	координаты объекта.
number	string	номер объекта
type_object	string	тип объекта (arbitrary,MKD)
start_video	integer	время начала видео записи на объекте
max_unavailability_time	integer	максимальное время неактивности камеры
description	string	описание объекта
dvr_depth	integer	глубина архива
montlypayment	integer	ежемесячная оплата
city_id	integer	идентификатор города
purpose_payment	integer	предоставляемая услуга
cost_additional_day_storage	integer	стоимость дополнительного дня хранения архива
fias_num	string	ФИАС
inn_mc	integer	ИНН управляющей компании
cityTitle	string	город
type	string	– тип населённого пункта (город, территория и т.д.)
count_cams	integer	количество камер на объекте
count_users	integer	количество пользователей на объекте
addresstrim	string	адрес объекта без доп. обозначений (пр-кт, мкр...)
count	integer	общее количество записей
success	boolean	информация о статусе запроса

Получение одного объекта

GET/api/v2/object/{identifier}

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

Параметры:
Ключ	Тип	Описание
limit	integer	ограничивает количество выходных данных
offset	integer	указывает число строк, которое необходимо пропустить в общем массиве данных
search	string	поиск
objectType	string	тип объекта МКД/произвольный (возможные значения - MKD,arbitrary)

Ответ:
Ключ	Тип	Описание
result	object	объект,содержащий ответ от сервера
object_id	integer	идентификатор объекта.
address	string	адрес объекта
title	string	название объекта
time_zone_id	integer	идентификатор часового пояса
cameras_monitoring	boolean	ведётся ли мониторинг камер на объекте
user_id	integer	идентификатор владельца.
gps	string	координаты объекта.
number	string	номер объекта
type_object	string	тип объекта (arbitrary,MKD)
start_video	integer	дата ввода в эксплуатацию
max_unavailability_time	integer	Максимальное время которое камера может быть неактивна без объявления о её неисправности
description	string	описание объекта
dvr_depth	integer	глубина хранения архива
montlypayment	integer	ежемесячная оплата
city_id	integer	идентификатор города
purpose_payment	integer	предоставляемая услуга
cost_additional_day_storage	integer	стоимость дня дополнительного хранения архива
fias_num	string	ФИАС
inn_mc	string	ИНН управляющей компании
name	string	страна
phone_mask	string	маска номера телефона
phone_code		код страны
country_prefix	string	префикс страны
iso_code	string	ISO код страны
cities_title	string	город
region_prefix	string	ISO код региона
region_title	string	регион
city_type	string	тип населённого пункта (город, территория и т.д.)
success	boolean	информация о статусе запроса

Добавление объекта (МКД)

POST/api/v2/objects

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

Параметры:
Ключ	Тип	Описание
cityId	integer	идентификатор города.
address	string	адрес.
dvrDepth	integer	глубина хранения архива.
gps	string	координаты gps.
inn	integer	ИНН управляющей компании
description	string	описание объекта
monthlyPayment	string	ежемесячная оплата
purposePayment	string	предоставляемая услуга.
regionPrefix	string	ISO код региона (KYA,ORE)
costAdditionalDayStorage	integer	стоимость дополнительного дня хранения архива
startDate	integer	дата и время ввода в эксплуатацию (формат UNIX)
fias	string	ФИАС
countryId	integer	идентификатор страны
camerasMonitoring	boolean	ведётся ли мониторинг камер на объекте
regionPrefix	string	ISO код региона
maxUnavailabilityTime	integer	максимальное время, которое камера может быть неактивна без объявления неисправности

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

Добавление объекта (Произвольный)

POST/api/v2/objects/arbitrary

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

Параметры:
Ключ	Тип	Описание
address	string	адрес.
title	string	название объекта.
timeZoneId	integer	идентификатор часового пояса
gps	string	координаты объекта
startDate	integer	дата ввода в эксплуатацию
camerasMonitoring	boolean	ведётся ли мониторинг на объекте
maxUnavailabilityTime	integer	максимальное время, которое камера может быть неактивна без объявления неисправности

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

Редактирование объекта (МКД)

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

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

Параметры:
Ключ	Тип	Описание
camerasMonitoring	boolean	мониторинг камер на объекте
address	string	адрес
gps	string	координаты gps
startVideo	integer	время ввода в эксплуатацию
maxUnavailabilityTime	integer	максимальное время, которое камера может быть неактивна без объявления неисправности
description	string	описание объекта
fias	string	ФИАС
cityId	integer	идентификатор города
dvrDepth	integer	глубина хранения архива
monthlyPayment	integer	ежемесячный платеж
purposePayment	string	предоставляемая услуга.
costAdditionslDayStorage	integer	стоимость дополнительного хранения архива
innMc	integer	ИНН управляющей компании
regionPrefix	string	ISO код региона

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

Редактирование объекта (Произвольный)

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

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

Параметры:
Ключ	Тип	Описание
camerasMonitoring	boolean	мониторинг камер на объекте
address	string	адрес
title	string	название объекта
gps	string	gps координаты
startVideo	integer	дата ввода в эксплуатацию
timeZoneId	integer	идентификатор часового пояса
maxUnavailabilityTime	integer	максимальное время, которое камера может быть неактивна без объявления неисправности

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

Api

Группы

Api

Пользователи

Содержание

Получение объектов
Получение одного объекта
Добавление объекта (МКД)
Добавление объекта (Произвольный)
Редактирование объекта (МКД)
Редактирование объекта (Произвольный)