Get In Process Alarms
This documentation will describe the Get In Process Alarms (XMAINPRO) endpoint. This endpoint allows users to obtain a list of alarms currently being handled by operators within Alarm Monitoring (the “In Process” queue).
See the Authentication documentation for information on how to obtain the authentication headers within the request.
Use cases
- Displaying a live view of alarms operators are actively working.
- Monitoring operator workload and handling times across the central station.
- Building an external dashboard that mirrors the In Process queue.
Supported attributes
| Attribute | Type | Required | Description |
|---|---|---|---|
*setMethod | string | Yes | Determines the endpoint you are calling. Must be XMAINPRO to view in process alarms. |
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="XMAINPRO"'
Example response
{
"XMAINPRO": [
{
"COLOR": "08",
"ACCOUNT_NUMBER": " KMN12",
"COMPANY_NAME": "Documentation Surveillance",
"STREET_NAME2": "123 Main St",
"CITY": "Bay City",
"STATE": "MI",
"TYPE": "*LTC*",
"OPR": "KMN",
"PEND_TIME": "00:04:18",
"BEEN_ON_HOLD": "X",
"OPR_RECEIVED": "00:00:09",
"OPR_FIRST_CALL": "00:01:32",
"OPR_HANDLING": "00:02:47"
},
{
"COLOR": "7C",
"COMPANY_NAME": "Not Receiving",
"OPR": "AJM"
},
{
"COLOR": "70",
"COMPANY_NAME": "Receiving Signals",
"OPR": "ABC"
}
],
"TOTAL_RECORDS": "2"
}
Response fields
The response contains two kinds of records: alarm records for alarms an operator is actively handling (these include the account and signal details), and operator status records (returning only COLOR, COMPANY_NAME, and OPR) that report each monitoring operator’s receiving status.
| Field | Description |
|---|---|
| COLOR | A color code indicating the priority or receiving status of the record. Used by the monitoring interface to color-code the row. |
| ACCOUNT_NUMBER | The subscriber account the alarm is assigned to (the account the alarm came in from). |
| COMPANY_NAME | For alarm records, the primary company name or the name of the individual responsible for the account. For operator status records, this field instead reports the operator’s receiving status: Receiving Signals, or Not Receiving. |
| STREET_NAME2 | The street address on the subscriber account. |
| CITY | The city on the subscriber account. |
| STATE | The state on the subscriber account. |
| TYPE | The alarm code received. |
| OPR | The operator code of the individual currently handling the alarm. |
| PEND_TIME | How long the alarm has been pending, in HH:MM:SS format. When the alarm has been pending for one or more days, the value is prefixed with the day count in DD HH:MM:SS format. |
| BEEN_ON_HOLD | Returned as X when the alarm has previously been placed on hold. This field is omitted when the alarm has not been on hold. |
| OPR_RECEIVED | The elapsed time before the operator received the alarm, in HH:MM:SS format. Omitted when not applicable. |
| OPR_FIRST_CALL | The elapsed time before the operator placed the first call, in HH:MM:SS format. Omitted when not applicable. |
| OPR_HANDLING | The amount of time the operator has been handling the alarm, in HH:MM:SS format. Omitted when not applicable. |
| TOTAL_RECORDS | The number of records retrieved by the request. |
Possible error messages
Invalid method
Verify XMAINPRO is specified for the *setMethod attribute.
{
"ERROR_CODE": "999",
"ERROR_DESCRIPTION": "INVALID%20METHOD%20METHOD",
"PROGRAM_ERROR": "11",
"PROGRAM_ERROR_DESCRIPTION": "Missing%20or%20Duplicate%20key",
"ERROR_ON_LINE": "240",
"ADDITIONAL_INFO": "%3CMETHOD_NAME%3EXMAINPR%20%3C%2FMETHOD_NAME%3E"
}