Get an Entrance

Get a specified entrance

Returns a specified entrance.

/acs/entrances/get

POSThttps://connect.getseam.com/acs/entrances/get
Authorization
Body
acs_entrance_id*string (uuid)
Response

OK

Body
acs_entrance*acs_entrance (object)
ok*boolean
Request
const response = await fetch('https://connect.getseam.com/acs/entrances/get', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();
Response
{
  "acs_entrance": {
    "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-07-14T17:53:19.500Z",
    "display_name": "text",
    "errors": [
      {
        "error_code": "text",
        "message": "text"
      }
    ],
    "latch_metadata": {
      "accessibility_type": "text",
      "door_name": "text",
      "door_type": "text",
      "is_connected": false
    },
    "visionline_metadata": {
      "door_name": "text",
      "door_category": "entrance",
      "profiles": [
        {
          "visionline_door_profile_id": "text",
          "visionline_door_profile_type": "BLE"
        }
      ]
    }
  },
  "ok": false
}

Request

Specify the desired entrance by including the corresponding acs_entrance_id in the request body.

Request Body Parameters

ParameterTypeDescription

acs_entrance_id

String (UUID) Required

ID of the desired entrance

Sample Request

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

Response

Returns an acs_entrance containing the following properties:

PropertyDescription

acs_entrance_id

ID of the entrance

acs_system_id

ID of the access control system that contains the entrance

workspace_id

ID of the workspace that contains the user

display_name

Display name for the entrance

XXX_metadata

ACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer

created_at

Date and time at which the entrance was created

Sample Response

This response contains manufacturer-specific metadata that may vary by manufacturer.

AcsEntrance(
  acs_entrance_id: '55555555-5555-5555-5555-555555555555',
  acs_system_id: '11111111-1111-1111-1111-111111111111',
  workspace_id: '00000000-0000-0000-0000-000000000000',
  visionline_metadata: {
    profiles: [
      {
        visionline_door_profile_id: 'Guest Door',
        visionline_door_profile_type: 'BLE'
      }
    ],
    door_name: 'Guest Lock 2',
    door_category: 'guest'
  },
  latch_metadata: null,
  display_name: 'Guest Lock 2',
  created_at: '2024-03-26T14:31:18.979Z'
)

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.