Track Receiver
This documentation will describe the Track Receiver (XMHSTOPT) endpoint. This endpoint allows users to view the receiver responsible for the specified alarm event.
See the Authentication documentation for information on how to obtain the authentication headers within the request.
Supported attributes
| Attribute | Type | Required | Description |
|---|---|---|---|
| *setMethod | string | Yes | Determines the endpoint you are calling. Must be XMHSTOPT to view the receiver. |
| OPTION | string | Yes | Determines the method you will be using. Use TRACK_REC to view the receiver. |
| INCIDENT_NUMBER | string | Yes | The unique identifier created by the system and assigned to the event. See the View Account History endpoint documentation for instructions on how to obtain event incident numbers. |
Example request
curl --location "https://example.securemcloud.com/rest/rest.php?dataSource=methods&*view=xmsubmit" \
--header 'X-DICE-APPKEY: {{X-DICE-APPKEY}}' \
--header 'X-DICE-USERNAME: {{X-DICE-USERNAME}}' \
--header 'X-DICE-DATE: {{X-DICE-DATE}}' \
--header 'X-DICE-NONCE: {{X-DICE-NONCE}}' \
--header 'X-DICE-DIGEST: {{X-DICE-DIGEST}}' \
--header 'Accept: application/json' \
--form '*setMethod="XMHSTOPT"' \
--form 'OPTION="TRACK_REC"' \
--form 'INCIDENT_NUMBER="736663,n"'
Example response
{
"RECEIVER_MSG": "Signal came from SURGARD #1 DV."
}