Report ACS Resources
Reports ACS system resources including encoders and entrances with their metadata.
This endpoint allows reporting of:
ACS encoders with removal status and encoder port metadata
ACS entrances with room number metadata
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:
// voidInform Seam that devices are connected to the ACS system or were removed.
Code:
curl --include --request POST "https://connect.getseam.com/acs/systems/report_devices" \
--header "Authorization: Bearer $SEAM_API_KEY" \
--json @- <<EOF
{
"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"
}
}
]
}
EOFOutput:
{}Inform Seam that devices are connected to the ACS system or were removed.
Code:
seam.acs.systems.report_devices(
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:
NoneInform Seam that devices are connected to the ACS system or were removed.
Code:
seam.acs.systems.report_devices(
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:
nilInform Seam that devices are connected to the ACS system or were removed.
Code:
$seam->acs->systems->report_devices(
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:
Inform Seam that devices are connected to the ACS system or were removed.
Code:
seam acs systems report-devices --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:
{}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
acs_entrances Array of Objects
Array of ACS entrances to report
Response
void
Last updated
Was this helpful?

