Get an Entrance

Get a specified entrance

Returns a specified entrance.

/acs/entrances/get

POSThttps://connect.getseam.com/acs/entrances/get

Authorization

api_keyaccess_tokenuser_sessionclient_session

Body

application/json

acs_entrance_id*string (uuid)

Response

200400401

OK

Body

application/json

acs_entrance*acs_entrance (object)

ok*boolean

Request

JavaScriptCurl

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_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
    "display_name": "text",
    "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-04-27T06:09:45.325Z",
    "latch_metadata": {
      "accessibility_type": "text",
      "door_name": "text",
      "door_type": "text",
      "is_connected": false
    },
    "errors": [
      {
        "error_code": "text",
        "message": "text"
      }
    ],
    "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

Parameter	Type	Description
acs_entrance_id	String (UUID) Required	ID of the desired entrance

Sample Request

Python

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

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/entrances/get' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_entrance_id": "55555555-5555-5555-5555-555555555555"
}'

JavaScript

await seam.acs.entrances.get({
  acs_entrance_id: "55555555-5555-5555-5555-555555555555"
});

Ruby

# Coming Soon!

PHP

$seam->acs->entrances->get(
  acs_entrance_id: "55555555-5555-5555-5555-555555555555"
);

C#

seam.EntrancesAcs.Get(
  acsEntranceId: "55555555-5555-5555-5555-555555555555"
);

Java

// Coming soon!

Go

acs_entrance, uErr := client.Acs.Entrances.Get(
  context.Background(), &acs.EntrancesGetRequest{
    AcsEntranceId: "55555555-5555-5555-5555-555555555555",
  },
)

Response

Returns an acs_entrance containing the following properties:

Property	Description
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.

Python

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'
)

cURL (bash)

{
  "acs_entrance": {
    "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"
  },
  "ok": true
}

JavaScript

{
  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'
}

Ruby

# Coming Soon!

PHP

{
  "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"
}

C#

{
  "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"
}

Java

// Coming soon!

Go

{
  "acs_entrance": {
    "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"
  },
  "ok": true
}