Skip to main content
POST
/
api
/
alertmonitoring
/
locationStatus
Get location status
curl --request POST \
  --url https://api2.rhombussystems.com/api/alertmonitoring/locationStatus \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "status": {
    "devicesWithActiveSirens": {},
    "disabledOnMs": 123,
    "enabled": true,
    "enabledOnMs": 123,
    "noNextTimestampReason": "<string>",
    "notEnabledReason": "<string>",
    "recentlyActivatedSirensTimestampMs": {}
  },
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request to retrieve alarm monitoring status for a specific location.

locationUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response containing alarm monitoring status for a specific location.

error
boolean | null
errorMsg
string | null
status
object

Map of location UUIDs to their monitoring enable status

warningMsg
string | null