Список доступов у помещения

GET 
/v1/rooms/:roomId/accesses

Request

Path Parameters

roomId stringrequired

Possible values: non-empty

Query Parameters

from string
to string
status string[]required

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

Header Parameters

x-api-key stringrequired

Responses

200

200

application/json

Schema

Schema

• Array [

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

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

• ]

Example (from schema)

[
  {
    "accessId": "string",
    "ownerId": "string",
    "accessCodeHint": "string",
    "status": "inactive",
    "room": {
      "roomId": "string",
      "ownerId": "string",
      "deviceId": "string",
      "name": "string",
      "address": "г. Уфа, ул. Зорге, 9, этаж 6, офис 604",
      "location": {
        "lat": 0,
        "lon": 0
      }
    },
    "medias": [
      {
        "mediaId": "string",
        "ownerId": "string",
        "roomId": "string",
        "name": "string",
        "contentType": "text/plain",
        "url": "string"
      }
    ],
    "codes": [
      {
        "device": {
          "deviceId": "string",
          "ownerId": "string",
          "parentDeviceId": "string",
          "name": "string"
        },
        "code": "string",
        "firstUseAt": "2024-06-15T14:51:11.072Z"
      }
    ],
    "text": "string"
  }
]

Loading...