JSON over HTTPS Alarms
Json over HTTP(s) is a common mechanism for devices and systems to send alarms. SureView can accept these alarms by setting the device/system to match the SureView JSON Alarm format below.
Endpoints
https://us.sureviewops.com:443/receiver
https://eu.sureviewops.com:443/receiver
Header (required)
Authorization: {API Key}
You must provide your unique account API Key in the header of the HTTP POST request, you can find this key in the Alarm Setup - HTTP Alarms tab.
Note: The API Key must be converted to Base64 for transmission
| Field | Description |
| systemIdentifier (required) |
The unique System Identifier for the specific alarm (or root alarm) that you are triggering. You can find this code in the "System Identifier" field of the alarm in HTTP Alarms tab in Alarm Setup |
| text (optional) |
The text description of the alarm that will be shown to the operator. For example "Door Forced has occurred at Front Door" |
| location (optional) |
Latitude,Longitude - pinpointing the location of the alarm |
| responseCode (optional) |
Note: This is an Advanced Option so we recommend you speak to SureView Support so we can help with the initial setup. When combined with the "Root Alarm" system identifier you can use this to match on your own response code identifier rather than a separate system generated one for each point. |
| eventCode (optional) |
Note: This is an Advanced Option so we recommend you speak to SureView Support so we can help with the initial setup. When combined with a custom Alarm Decoder this lets you specify your own specific event types to decode. |
Example
Header
Authorization: NTdCNTQ1NjEzM0RFMTQzRDhCQTY0NENCNTZFOTA4REUxN0YxMzgxQkRFQjI1RjhBMzU0MUZBMTM1NjE2OTgxRkQzQUZERDAwN0ExQjcwMEYzOTI2MDNEOUU1ODJBODRCNzIyMjdBMzFBMkFFNkVFOTFENjBDQTE2MzYyQUU3NDE=
Body
{
"text": "Door Forced - Front Entrance",
"systemIdentifier": "9z5138b9ak",
"location": "27.947380,-82.460741"
}This will trigger a "Door Forced - Front Entrance" alarm at location 27.947380,-82.460741 for the alarm point matching 9z5138b9ak in Alarm Setup - HTTP Alarms tab
Comments
0 commentsPlease sign in to leave a comment.