Entrances

The acs_entrance Object

• Properties

• Errors

• Warnings

• Events

• Endpoints

Represents an entrance within an access control system.

In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the acs_entrance resources in your workspace or get these details for a specific acs_entrance. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.

JSON

{
  acs_entrance_id: [example value],
  acs_system_id: [example value],
  assa_abloy_vostio_metadata: [example value],
  created_at: [example value],
  display_name: [example value],
  dormakaba_community_metadata: [example value],
  errors: [example value],
  latch_metadata: [example value],
  salto_ks_metadata: [example value],
  salto_space_metadata: [example value],
  visionline_metadata: [example value]
}

---

Properties

acs_entrance_id UUID

ID of the entrance.

---

acs_system_id UUID

ID of the access control system that contains the entrance.

---

assa_abloy_vostio_metadata Object

ASSA ABLOY Vostio-specific metadata associated with the entrance.

Child Properties

• door_name String

• door_number Number

• door_type Enum

• pms_id String

• stand_open Boolean

---

created_at Datetime

Date and time at which the entrance was created.

---

display_name String

Display name for the entrance.

---

dormakaba_community_metadata Object

dormakaba Community-specific metadata associated with the entrance.

Child Properties

• access_point_name String

---

errors List of Objects

Errors associated with the entrance.

Child Object Properties

error_code String

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

---

latch_metadata Object

Latch-specific metadata associated with the entrance.

Child Properties

• accessibility_type String

• door_name String

• door_type String

• is_connected Boolean

---

salto_ks_metadata Object

Salto KS-specific metadata associated with the entrance.

Child Properties

• battery_level String

• door_name String

• intrusion_alarm Boolean

• left_open_alarm Boolean

• lock_type String

• locked_state String

• online Boolean

• privacy_mode Boolean

---

salto_space_metadata Object

Salto Space-specific metadata associated with the entrance.

Child Properties

• door_description String

• door_name String

• ext_door_id String

---

visionline_metadata Object

Visionline-specific metadata associated with the entrance.

Child Properties

• door_category Enum

• door_name String

• profiles List of Objects

• visionline_door_profile_id String

• visionline_door_profile_type Enum

---

Events

acs_entrance.added

An ACS entrance was added.

Properties

acs_entrance_id UUID

acs_system_id UUID

ID of the access system.

connected_account_id UUID

ID of the connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: acs_entrance.added

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

acs_entrance.removed

An ACS entrance was removed.

Properties

acs_entrance_id UUID

acs_system_id UUID

ID of the access system.

connected_account_id UUID

ID of the connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: acs_entrance.removed

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

Endpoints

/acs/entrances/get

Returns a specified access system entrance.

/acs/entrances/grant_access

Grants a specified access system user access to a specified access system entrance.

/acs/entrances/list

Returns a list of all access system entrances.

/acs/entrances/list_credentials_with_access

Returns a list of all credentials with access to a specified entrance.