Skip to main content
POST
/
api
/
alertmonitoring
/
getAlertMonitoringSettingsForLocation
Get alert monitoring settings for location
curl --request POST \
  --url https://api2.rhombussystems.com/api/alertmonitoring/getAlertMonitoringSettingsForLocation \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "includePreviousVersions": false,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "alertMonitoringSettings": {
    "acceptedTermsOfService": true,
    "badgeAuthDisablesMonitoring": true,
    "defaultDelay": 123,
    "defaultEmergencyContact": {
      "name": "<string>",
      "phoneNumber": "<string>"
    },
    "defaultPromptTheme": "THREAT",
    "deleted": true,
    "disabledOnMs": 123,
    "emergencyContacts": [
      {
        "deviceUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "emergencyContactList": [
          {
            "name": "<string>",
            "phoneNumber": "<string>"
          }
        ],
        "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "enabled": true,
    "enabledOnMs": 123,
    "entryInstructions": "<string>",
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "manualEscalationSettings": {
      "audioGateways": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "escalationDelayMinutes": 123,
      "monitoredDevices": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "promptTheme": "THREAT",
      "promptTitle": "<string>",
      "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "sirenSettings": {},
      "triggerSet": [
        "SOUND_LOUD"
      ],
      "tripwire": {
        "intervalSeconds": 123,
        "threshold": 123
      },
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "verifiedThreatSiren": {
        "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "durationSeconds": 123,
        "playCount": 123
      }
    },
    "modifiedByEmail": "<string>",
    "modifiedByIntegration": true,
    "modifiedByMetadata": "<string>",
    "modifiedByUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "modifiedTimeMs": 123,
    "monitoringMode": "MANUAL",
    "oneTimePauses": [
      {
        "audioGateways": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "escalationDelayMinutes": 123,
        "monitoredDevices": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "promptTheme": "THREAT",
        "promptTitle": "<string>",
        "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "sirenSettings": {},
        "triggerSet": [
          "SOUND_LOUD"
        ],
        "tripwire": {
          "intervalSeconds": 123,
          "threshold": 123
        },
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "verifiedThreatSiren": {
          "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "durationSeconds": 123,
          "playCount": 123
        }
      }
    ],
    "oneTimeSchedules": [
      {
        "audioGateways": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "escalationDelayMinutes": 123,
        "monitoredDevices": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "promptTheme": "THREAT",
        "promptTitle": "<string>",
        "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "sirenSettings": {},
        "triggerSet": [
          "SOUND_LOUD"
        ],
        "tripwire": {
          "intervalSeconds": 123,
          "threshold": 123
        },
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "verifiedThreatSiren": {
          "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "durationSeconds": 123,
          "playCount": 123
        }
      }
    ],
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "pins": [
      {
        "description": "<string>",
        "name": "<string>",
        "pin": "<string>"
      }
    ],
    "rules": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "schedules": [
      {
        "audioGateways": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "escalationDelayMinutes": 123,
        "monitoredDevices": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "promptTheme": "THREAT",
        "promptTitle": "<string>",
        "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "sirenSettings": {},
        "triggerSet": [
          "SOUND_LOUD"
        ],
        "tripwire": {
          "intervalSeconds": 123,
          "threshold": 123
        },
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "verifiedThreatSiren": {
          "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "durationSeconds": 123,
          "playCount": 123
        }
      }
    ],
    "status": {
      "devicesWithActiveSirens": {},
      "disabledOnMs": 123,
      "enabled": true,
      "enabledOnMs": 123,
      "noNextTimestampReason": "<string>",
      "notEnabledReason": "<string>",
      "recentlyActivatedSirensTimestampMs": {}
    },
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "talkdownEnabled": true
  },
  "error": true,
  "errorMsg": "<string>",
  "previousVersions": [
    {
      "acceptedTermsOfService": true,
      "badgeAuthDisablesMonitoring": true,
      "defaultDelay": 123,
      "defaultEmergencyContact": {
        "name": "<string>",
        "phoneNumber": "<string>"
      },
      "defaultPromptTheme": "THREAT",
      "deleted": true,
      "emergencyContacts": [
        {
          "deviceUuids": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "emergencyContactList": [
            {
              "name": "<string>",
              "phoneNumber": "<string>"
            }
          ],
          "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "enabled": true,
      "entryInstructions": "<string>",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "manualEscalationSettings": {
        "audioGateways": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "escalationDelayMinutes": 123,
        "monitoredDevices": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "promptTheme": "THREAT",
        "promptTitle": "<string>",
        "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "sirenSettings": {},
        "triggerSet": [
          "SOUND_LOUD"
        ],
        "tripwire": {
          "intervalSeconds": 123,
          "threshold": 123
        },
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "verifiedThreatSiren": {
          "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "durationSeconds": 123,
          "playCount": 123
        }
      },
      "modifiedByEmail": "<string>",
      "modifiedByIntegration": true,
      "modifiedByMetadata": "<string>",
      "modifiedByUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "modifiedTimeMs": 123,
      "monitoringMode": "MANUAL",
      "oneTimePauses": [
        {
          "audioGateways": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "escalationDelayMinutes": 123,
          "monitoredDevices": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "promptTheme": "THREAT",
          "promptTitle": "<string>",
          "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "sirenSettings": {},
          "triggerSet": [
            "SOUND_LOUD"
          ],
          "tripwire": {
            "intervalSeconds": 123,
            "threshold": 123
          },
          "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "verifiedThreatSiren": {
            "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "durationSeconds": 123,
            "playCount": 123
          }
        }
      ],
      "oneTimeSchedules": [
        {
          "audioGateways": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "escalationDelayMinutes": 123,
          "monitoredDevices": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "promptTheme": "THREAT",
          "promptTitle": "<string>",
          "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "sirenSettings": {},
          "triggerSet": [
            "SOUND_LOUD"
          ],
          "tripwire": {
            "intervalSeconds": 123,
            "threshold": 123
          },
          "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "verifiedThreatSiren": {
            "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "durationSeconds": 123,
            "playCount": 123
          }
        }
      ],
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pins": [
        {
          "description": "<string>",
          "name": "<string>",
          "pin": "<string>"
        }
      ],
      "rules": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "schedules": [
        {
          "audioGateways": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "escalationDelayMinutes": 123,
          "monitoredDevices": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "promptTheme": "THREAT",
          "promptTitle": "<string>",
          "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "sirenSettings": {},
          "triggerSet": [
            "SOUND_LOUD"
          ],
          "tripwire": {
            "intervalSeconds": 123,
            "threshold": 123
          },
          "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "verifiedThreatSiren": {
            "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "durationSeconds": 123,
            "playCount": 123
          }
        }
      ],
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "talkdownEnabled": true
    }
  ],
  "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 alert monitoring settings for a specific location.

​
includePreviousVersions
boolean | null

If provided and true, response will contain a list of previous versions of the settings. For debugging purposes.

Example:

false

​
locationUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response containing alert monitoring settings for a specific location.

​
alertMonitoringSettings
object

Web service settings for Noonlight integration with alert monitoring.

​
error
boolean | null
​
errorMsg
string | null
​
previousVersions
object[] | null

List of previous versions of the alert monitoring settings

​
warningMsg
string | null