Список событий у помещения

GET 
/v1/rooms/:roomId/events

Request

Path Parameters

roomId stringrequired

Possible values: non-empty

Query Parameters

from string
to string
type string[]

Possible values: [access.created, access.updated, access.deleted, access.code-used, device.unlocked]

Header Parameters

x-api-key stringrequired

Responses

200

200

application/json

Schema

Schema

• Array [

oneOf

MOD1

type stringrequired

Possible values: [access.created]

at date-timerequired

access

object

required

accessId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

from required

Дата и время

to required

Дата и время

accessCodeHint string

Подсказка к генерации кода, по последним цифрам которого будет генериться код доступа. Обычно это номер телефона.

status stringrequired

Possible values: [inactive, active, expired, deleted]

room

object

required

Помещение

roomId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

deviceId stringnullable

Possible values: non-empty

ID устройства, пройдя который входишь в помещение

name stringrequired

Короткое наименование помещения

address stringrequired

Полный адрес

location

object

Географические координаты

lat numberrequired

Possible values: >= -90 and <= 90

Широта

lon numberrequired

Possible values: >= -180 and <= 180

Долгота

medias

object[]

required

Array [

mediaId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

roomId stringnullable

Possible values: non-empty

name string

contentType stringrequired

Possible values: [text/plain, application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/jpeg, image/png]

url urirequired

]

codes

object[]

required

Array [

device

object

required

Устройство без конфигурации

deviceId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

parentDeviceId stringnullable

Possible values: non-empty

name stringrequired

Наименование устройства

code stringrequired

Код доступа

firstUseAt date-timenullable

Момент первой разблокировки устройства TTLock кодом доступа, null - если еще не было разблокировки, undefined - если устройство не предоставляет события разблокировки (кейбокс/домофон)

]

text stringrequired

Данные доступа в текстовом виде

MOD2

type stringrequired

Possible values: [access.updated]

at date-timerequired

access

object

required

accessId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

from required

Дата и время

to required

Дата и время

accessCodeHint string

Подсказка к генерации кода, по последним цифрам которого будет генериться код доступа. Обычно это номер телефона.

status stringrequired

Possible values: [inactive, active, expired, deleted]

room

object

required

Помещение

roomId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

deviceId stringnullable

Possible values: non-empty

ID устройства, пройдя который входишь в помещение

name stringrequired

Короткое наименование помещения

address stringrequired

Полный адрес

location

object

Географические координаты

lat numberrequired

Possible values: >= -90 and <= 90

Широта

lon numberrequired

Possible values: >= -180 and <= 180

Долгота

medias

object[]

required

Array [

mediaId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

roomId stringnullable

Possible values: non-empty

name string

contentType stringrequired

Possible values: [text/plain, application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/jpeg, image/png]

url urirequired

]

codes

object[]

required

Array [

device

object

required

Устройство без конфигурации

deviceId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

parentDeviceId stringnullable

Possible values: non-empty

name stringrequired

Наименование устройства

code stringrequired

Код доступа

firstUseAt date-timenullable

Момент первой разблокировки устройства TTLock кодом доступа, null - если еще не было разблокировки, undefined - если устройство не предоставляет события разблокировки (кейбокс/домофон)

]

text stringrequired

Данные доступа в текстовом виде

MOD3

type stringrequired

Possible values: [access.deleted]

at date-timerequired

access

object

required

accessId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

from required

Дата и время

to required

Дата и время

accessCodeHint string

Подсказка к генерации кода, по последним цифрам которого будет генериться код доступа. Обычно это номер телефона.

status stringrequired

Possible values: [inactive, active, expired, deleted]

room

object

required

Помещение

roomId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

deviceId stringnullable

Possible values: non-empty

ID устройства, пройдя который входишь в помещение

name stringrequired

Короткое наименование помещения

address stringrequired

Полный адрес

location

object

Географические координаты

lat numberrequired

Possible values: >= -90 and <= 90

Широта

lon numberrequired

Possible values: >= -180 and <= 180

Долгота

medias

object[]

required

Array [

mediaId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

roomId stringnullable

Possible values: non-empty

name string

contentType stringrequired

Possible values: [text/plain, application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/jpeg, image/png]

url urirequired

]

codes

object[]

required

Array [

device

object

required

Устройство без конфигурации

deviceId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

parentDeviceId stringnullable

Possible values: non-empty

name stringrequired

Наименование устройства

code stringrequired

Код доступа

firstUseAt date-timenullable

Момент первой разблокировки устройства TTLock кодом доступа, null - если еще не было разблокировки, undefined - если устройство не предоставляет события разблокировки (кейбокс/домофон)

]

text stringrequired

Данные доступа в текстовом виде

MOD4

type stringrequired

Possible values: [access.code-used]

at date-timerequired

access

object

required

accessId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

from required

Дата и время

to required

Дата и время

accessCodeHint string

Подсказка к генерации кода, по последним цифрам которого будет генериться код доступа. Обычно это номер телефона.

status stringrequired

Possible values: [inactive, active, expired, deleted]

room

object

required

Помещение

roomId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

deviceId stringnullable

Possible values: non-empty

ID устройства, пройдя который входишь в помещение

name stringrequired

Короткое наименование помещения

address stringrequired

Полный адрес

location

object

Географические координаты

lat numberrequired

Possible values: >= -90 and <= 90

Широта

lon numberrequired

Possible values: >= -180 and <= 180

Долгота

medias

object[]

required

Array [

mediaId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

roomId stringnullable

Possible values: non-empty

name string

contentType stringrequired

Possible values: [text/plain, application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/jpeg, image/png]

url urirequired

]

codes

object[]

required

Array [

device

object

required

Устройство без конфигурации

deviceId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

parentDeviceId stringnullable

Possible values: non-empty

name stringrequired

Наименование устройства

code stringrequired

Код доступа

firstUseAt date-timenullable

Момент первой разблокировки устройства TTLock кодом доступа, null - если еще не было разблокировки, undefined - если устройство не предоставляет события разблокировки (кейбокс/домофон)

]

text stringrequired

Данные доступа в текстовом виде

device

object

required

device

object

required

Устройство без конфигурации

deviceId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

parentDeviceId stringnullable

Possible values: non-empty

name stringrequired

Наименование устройства

code stringrequired

Код доступа

firstUseAt date-timenullable

Момент первой разблокировки устройства TTLock кодом доступа, null - если еще не было разблокировки, undefined - если устройство не предоставляет события разблокировки (кейбокс/домофон)

isFirstUse booleanrequired

MOD5

type stringrequired

Possible values: [device.unlocked]

at date-timerequired

device

object

required

Устройство без конфигурации

deviceId stringnullable

Possible values: non-empty

ownerId stringnullable

Possible values: non-empty

parentDeviceId stringnullable

Possible values: non-empty

name stringrequired

Наименование устройства

• ]

Example (from schema)

[
  {},
  {},
  {},
  {},
  {}
]

Loading...