Alert Monitoring Webservice

Get alert monitoring settings for location

Retrieve alert monitoring settings by location.

post/api/alertmonitoring/getAlertMonitoringSettingsForLocation

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/alertmonitoring/getAlertMonitoringSettingsForLocation
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

includePreviousVersionsboolean nullable

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

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "alertMonitoringSettings": {
    "emergencyContacts": [
      {
        "deviceUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "manualEscalationSettings": {
      "audioGateways": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "monitoredDevices": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "verifiedThreatSiren": {
        "audioGateways": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    },
    "modifiedByUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "oneTimePauses": [
      {
        "audioGateways": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "monitoredDevices": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "verifiedThreatSiren": {
          "audioGateways": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      }
    ],
    "oneTimeSchedules": [
      {
        "audioGateways": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "monitoredDevices": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "verifiedThreatSiren": {
          "audioGateways": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      }
    ],
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "rules": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "schedules": [
      {
        "audioGateways": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "monitoredDevices": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "verifiedThreatSiren": {
          "audioGateways": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      }
    ],
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
  },
  "previousVersions": [
    {
      "emergencyContacts": [
        {
          "deviceUuids": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "manualEscalationSettings": {
        "audioGateways": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "monitoredDevices": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "verifiedThreatSiren": {
          "audioGateways": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      },
      "modifiedByUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "oneTimePauses": [
        {
          "audioGateways": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "monitoredDevices": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "verifiedThreatSiren": {
            "audioGateways": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          }
        }
      ],
      "oneTimeSchedules": [
        {
          "audioGateways": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "monitoredDevices": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "verifiedThreatSiren": {
            "audioGateways": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          }
        }
      ],
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rules": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "schedules": [
        {
          "audioGateways": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "monitoredDevices": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "verifiedThreatSiren": {
            "audioGateways": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          }
        }
      ],
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.