Alert Monitoring Webservice

Get organization status

Retrieve summary of the alarm monitoring status for all locations

post/api/alertmonitoring/orgStatus

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/alertmonitoring/orgStatus
  • 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

includeDeletedboolean nullable

If true, includes alert monitoring settings that were soft deleted in the response.

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
locationStatusesobject nullable

Map of location UUIDs to their monitoring enable status

warningMsgstring nullable

Changes

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