Entrances

acs_entrance

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.

acs_entrance_id

Format: UUID

ID of the entrance.

---

acs_system_id

Format: UUID

ID of the access control system that contains the entrance.

---

assa_abloy_vostio_metadata

Format: Object

ASSA ABLOY Vostio-specific metadata associated with the entrance.

door_name Format: String

door_number Format: Number

door_type Format: Enum

Possible enum values:

• CommonDoor

• EntranceDoor

• GuestDoor

• Elevator

pms_id Format: String

stand_open Format: Boolean

---

created_at

Format: Datetime

Date and time at which the entrance was created.

---

display_name

Format: String

Display name for the entrance.

---

dormakaba_community_metadata

Format: Object

dormakaba Community-specific metadata associated with the entrance.

access_point_name Format: String

---

errors

Format: List

Item format: Object

Errors associated with the entrance.

error_code Format: String

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

message Format: String

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

---

latch_metadata

Format: Object

Latch-specific metadata associated with the entrance.

accessibility_type Format: String

door_name Format: String

door_type Format: String

is_connected Format: Boolean

---

salto_ks_metadata

Format: Object

Salto KS-specific metadata associated with the entrance.

battery_level Format: String

door_name Format: String

intrusion_alarm Format: Boolean

left_open_alarm Format: Boolean

lock_type Format: String

locked_state Format: String

online Format: Boolean

privacy_mode Format: Boolean

---

salto_space_metadata

Format: Object

Salto Space-specific metadata associated with the entrance.

door_description Format: String

door_name Format: String

ext_door_id Format: String

---

visionline_metadata

Format: Object

Visionline-specific metadata associated with the entrance.

door_category Format: Enum

Possible enum values:

• entrance

• guest

• elevator reader

• common

• common (PMS)

door_name Format: String

profiles Format: List Item format: Object

• visionline_door_profile_id Format: String

• visionline_door_profile_type Format: Enum

  Possible enum values:

  • BLE

  • commonDoor

  • touch

---

Endpoints

/acs/entrances/get

Returns a specified ACS entrance.

/acs/entrances/grant_access

/acs/entrances/list

Returns a list of all ACS entrances.

/acs/entrances/list_credentials_with_access

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

---

Events

acs_entrance.added

An ACS entrance was added.

acs_entrance_id Format: UUID

acs_system_id Format: UUID

ID of the ACS system.

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: Enum

Value: acs_entrance.added

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

---

acs_entrance.removed

An ACS entrance was removed.

acs_entrance_id Format: UUID

acs_system_id Format: UUID

ID of the ACS system.

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: Enum

Value: acs_entrance.removed

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

---