Retrieving Entrance Details

Learn how to get details about the entrances in your ACS, including listing the credentials that provide access to a specific entrance.

In an ACS, 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.


List All Entrances

You can list all acs_entrance resources in your workspace. Note that entrance details include manufacturer-specific metadata that may vary by manufacturer.

Request:

seam.acs.entrances.list()

Response:

[
  AcsEntrance(
    acs_entrance_id='55555555-5555-5555-5555-555555555555',
    acs_system_id='11111111-1111-1111-1111-111111111111',
    workspace_id='00000000-0000-0000-0000-000000000000',
    display_name='Guest Lock 2',
    ....
  ),
  ...
]

List Entrances in an ACS

To list all acs_entrances in a specific ACS, include the acs_system_id filter in the List Entrances request. Note that entrance details include manufacturer-specific metadata that may vary by manufacturer.

Request:

seam.acs.entrances.list(
  acs_system_id="11111111-1111-1111-1111-111111111111"
)

Response:

[
  AcsEntrance(
    acs_entrance_id='55555555-5555-5555-5555-555555555555',
    acs_system_id='11111111-1111-1111-1111-111111111111',
    workspace_id='00000000-0000-0000-0000-000000000000',
    display_name='Guest Lock 2',
    ....
  ),
  ...
]

List Entrances Associated with a Credential

To list all acs_entrances associated with a specific ACS, include the acs_credential_id filter in the List Entrances request. Note that entrance details include manufacturer-specific metadata that may vary by manufacturer.

Request:

seam.acs.entrances.list(
  acs_credential_id="66666666-6666-6666-6666-666666666666"
)

Response:

[
  AcsEntrance(
    acs_entrance_id='55555555-5555-5555-5555-555555555555',
    acs_system_id='11111111-1111-1111-1111-111111111111',
    workspace_id='00000000-0000-0000-0000-000000000000',
    display_name='Guest Lock 2',
    ....
  ),
  ...
]

Get an Entrance

You can get the details of a specific acs_entrance. Note that entrance details include manufacturer-specific metadata that may vary by manufacturer.

Request:

seam.acs.entrances.get(
  acs_entrance_id="55555555-5555-5555-5555-555555555555"
)

Response:

AcsEntrance(
  acs_entrance_id: '55555555-5555-5555-5555-555555555555',
  acs_system_id: '11111111-1111-1111-1111-111111111111',
  workspace_id: '00000000-0000-0000-0000-000000000000',
  display_name: 'Guest Lock 2',
  ...
)

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.