Report Devices

Reports ACS system device status including encoders and entrances.

Inform Seam that devices are connected to the ACS system or were removed.

Code:

await seam.acs.systems.reportDevices({
  acs_system_id: "182ea706-8e14-4921-8e57-ee18d5a7de31",
  acs_encoders: [
    { hotek_metadata: { encoder_number: "1" } },
    { is_removed: true, hotek_metadata: { encoder_number: "2" } },
  ],
  acs_entrances: [
    { hotek_metadata: { room_number: "203" } },
    { is_removed: true, hotek_metadata: { room_number: "500" } },
    { hotek_metadata: { common_area_name: "Gym", common_area_number: "2" } },
  ],
});

Output:

// void
Authentication Methods
  • API key

  • Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

acs_system_id String (Required)

ID of the ACS system to report resources for


acs_encoders Array of Objects

Array of ACS encoders to report

hotek_metadata Object

Hotek-specific metadata associated with the entrance.


hotek_metadata.encoder_number String

The encoder number determined by the USB port connection.


is_removed Boolean

Whether the encoder is removed


acs_entrances Array of Objects

Array of ACS entrances to report

hotek_metadata Object

Hotek-specific metadata associated with the entrance.


hotek_metadata.common_area_name String

The common area name


hotek_metadata.common_area_number String

The room number identifier


hotek_metadata.room_number String

The room number identifier


is_removed Boolean

Whether the entrance is removed


Response

void

Last updated

Was this helpful?