Systems

acs_system

Represents an access control system.

Within an acs_system, create acs_users and acs_credentials to grant access to the acs_users.

For details about the resources associated with an access control system, see the access control systems namespace.

acs_system_id

Format: UUID

ID of the access control system.

---

can_add_acs_users_to_acs_access_groups

Format: Boolean

Indicates whether the access control system supports adding users to access groups. See also Access Group-based Access Control Systems.

---

can_automate_enrollment

Format: Boolean

Indicates whether it is possible to launch enrollment automations for the access control system.

---

can_create_acs_access_groups

Format: Boolean

Indicates whether the access control system supports creating access groups. See also Access Group-based Access Control Systems.

---

can_remove_acs_users_from_acs_access_groups

Format: Boolean

Indicates whether the access control system supports removing users from access groups. See also Access Group-based Access Control Systems.

---

connected_account_id

Format: UUID

ID of the connected account associated with the access control system.

---

connected_account_ids

Deprecated. Use connected_account_id.

Format: List

Item format: UUID

IDs of the connected accounts associated with the access control system.

---

created_at

Format: Datetime

Date and time at which the access control system was created.

---

default_credential_manager_acs_system_id

Format: UUID

ID of the default credential manager acs_system for this access control system.

---

errors

Format: List

Item format: Object

Errors associated with the access control system.

---

external_type

Format: Enum

Brand-specific terminology for the access control system type.

Possible enum values:

• pti_site

• alta_org

• salto_ks_site

• salto_space_system

• brivo_account

• hid_credential_manager_organization

• visionline_system

• assa_abloy_credential_service

• latch_building

• dormakaba_community_site

• legic_connect_credential_service

• assa_abloy_vostio

• assa_abloy_vostio_credential_service

---

external_type_display_name

Format: String

Display name that corresponds to the brand-specific terminology for the access control system type.

---

image_alt_text

Format: String

Alternative text for the access control system image.

---

image_url

Format: String

URL for the image that represents the access control system.

---

is_credential_manager

Format: Boolean

Indicates whether the acs_system is a credential manager.

---

location

Format: Object

time_zone Format: String

Time zone in which the access control system is located.

---

name

Format: String

Name of the access control system.

---

system_type

Deprecated. Use external_type.

Format: Enum

Possible enum values:

• pti_site

• alta_org

• salto_ks_site

• salto_space_system

• brivo_account

• hid_credential_manager_organization

• visionline_system

• assa_abloy_credential_service

• latch_building

• dormakaba_community_site

• legic_connect_credential_service

• assa_abloy_vostio

• assa_abloy_vostio_credential_service

---

system_type_display_name

Deprecated. Use external_type_display_name.

Format: String

---

visionline_metadata

Format: Object

lan_address Format: String

IP address or hostname of the main Visionline server relative to Seam Bridge on the local network.

mobile_access_uuid Format: String

Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.

system_id Format: String

Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.

---

warnings

Format: List

Item format: Object

Warnings associated with the access control system.

---

workspace_id

Format: UUID

ID of the workspace that contains the access control system.

---

Errors

seam_bridge_disconnected

Indicates that the Seam API cannot communicate with Seam Bridge, for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. This error might also occur if Seam Bridge is connected to the wrong workspace. See also Troubleshooting Your Access Control System.

---

visionline_instance_unreachable

Indicates that Seam Bridge is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises Visionline access control system. For example, the IP address of the on-premises access control system may be set incorrectly within the Seam workspace. See also Troubleshooting Your Access Control System.

---

salto_ks_subscription_limit_exceeded

Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.

---

acs_system_disconnected

Indicates that the access control system has been disconnected. See Troubleshooting Your Access Control System to resolve the issue.

---

account_disconnected

Indicates that the login credentials are invalid. Reconnect the account using a Connect Webview to restore access.

---

salto_ks_certification_expired

Indicates that the access control system has lost its Salto KS certification. Contact support to regain access.

---

Warnings

salto_ks_subscription_limit_almost_reached

Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.

---

time_zone_does_not_match_location

Indicates the access control system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances.

---

Endpoints

/acs/systems/get

Returns a specified access control system.

/acs/systems/list

Returns a list of all access control systems.

/acs/systems/list_compatible_credential_manager_acs_systems

Returns a list of all credential manager ACS systems that are compatible with a specifiedaccess control system.

---

Events

acs_system.connected

An ACS system was connected.

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: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

---

acs_system.added

An ACS system was added.

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: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

---

acs_system.disconnected

An ACS system was disconnected.

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: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

---