Get Pending Alarms
This documentation will describe the Get Pending Alarms (XMAPEND) endpoint. This endpoint allows users to obtain a list of alarms currently within the pending queue of Alarm Monitoring.
Use cases
- Configuring an external alerting product to send a notification if a service is down.
- Managing a status monitor that shows if anything is down.
- Monitoring the age of pending alarms.
Supported attributes
| Attribute | Type | Required | Description |
|---|---|---|---|
| *setMethod | string | Yes | Determines the endpoint you are calling. Must be XMAPEND to view pending alarms. |
| FIXED_HISTORY_TAG | string | No | Determines the format of the History Event NTD tag name. Set to Y to standardize HISTORY-EVENT-NTD output to HISTORY_EVENT_NTD. Set to N to use HISTORY-EVENT-NTD. |
| SOURCE | string | Y | Set to DATAENTRY to view pending 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="XMAPEND"' \
--form 'FIXED_HISTORY_TAG="Y"' \
--form 'SOURCE="DATAENTRY"'
Example response
{
"XMAPEND": [
{
"PRIORITY": "z",
"PASSCODE_VERIFIED": "N",
"PENDING_TIME": "738972.69799",
"PEND_TIME": "16:45:06",
"PEND_DATE": "03/25/2024",
"HISTORY_TIME": "16:45:06",
"ACCOUNT_NUMBER": " D1",
"INCIDENT_NUMBER": "11562786",
"HIST_TEXT": "*L T C* LATE TO CLOSE",
"COMPANY_NAME": "GOLF BALLS 'R' US",
"HISTORY_EVENT_NTD": "738972.69799",
"TYPE": "*LTC*",
"TRACK_GROUPING": "TEST2",
"CONTACT_LIST": "NOTIFY"
},
{
"PRIORITY": "z",
"PASSCODE_VERIFIED": "N",
"PENDING_TIME": "738973.00002",
"PEND_TIME": "00:00:02",
"PEND_DATE": "03/26/2024",
"HISTORY_TIME": "00:00:02",
"ACCOUNT_NUMBER": " CENTRAL",
"INCIDENT_NUMBER": "11562884",
"HIST_TEXT": "HOL NH1, PRB #6R: (NH1)",
"COMPANY_NAME": "DICE CENTRAL STATION",
"HISTORY_EVENT_NTD": "738973.00002",
"TYPE": "ALERT"
},
{
"PRIORITY": "z",
"PASSCODE_VERIFIED": "N",
"PENDING_TIME": "738973.40633",
"PEND_TIME": "09:45:07",
"PEND_DATE": "03/26/2024",
"HISTORY_TIME": "09:45:07",
"ACCOUNT_NUMBER": "NW0000000",
"INCIDENT_NUMBER": "11562890",
"HIST_TEXT": "*L T O* LATE TO OPEN",
"COMPANY_NAME": "TEST ACCT",
"HISTORY_EVENT_NTD": "738973.40633",
"TYPE": "*LTO*",
"TRACK_GROUPING": "ANDY",
"CONTACT_LIST": "NOTIFY"
},
{
"PRIORITY": "z",
"PASSCODE_VERIFIED": "N",
"PENDING_TIME": "738974.00002",
"PEND_TIME": "00:00:02",
"PEND_DATE": "03/27/2024",
"HISTORY_TIME": "00:00:02",
"ACCOUNT_NUMBER": " CENTRAL",
"INCIDENT_NUMBER": "11562992",
"HIST_TEXT": "HOL NH1, PRB #6R: (NH1)",
"COMPANY_NAME": "DICE CENTRAL STATION",
"HISTORY_EVENT_NTD": "738974.00002",
"TYPE": "ALERT"
},
{
"PRIORITY": "z",
"PASSCODE_VERIFIED": "N",
"PENDING_TIME": "738978.99940",
"PEND_TIME": "23:59:08",
"PEND_DATE": "03/31/2024",
"HISTORY_TIME": "23:59:08",
"ACCOUNT_NUMBER": " KMN12",
"INCIDENT_NUMBER": "11563395",
"HIST_TEXT": "*L T C* LATE TO CLOSE",
"COMPANY_NAME": "Documentation Surveillance",
"HISTORY_EVENT_NTD": "738978.99940",
"TYPE": "*LTC*",
"TRACK_GROUPING": "ALARM",
"CONTACT_LIST": "NOTIFY"
}
],
"TOTAL_RECORDS": "5"
}
Response fields
| Field | Description |
|---|---|
| PRIORITY | The importance assigned to the alarm type. |
| PASSCODE_VERIFIED | Whether or not a passcode was verified on the alarm. |
| PENDING_TIME | The NTD time the alarm was delivered to pending. |
| PEND_TIME | The time the alarm was received by the system in HH:MM:SS format. |
| PEND_DATE | The date the alarm was received by the system in MM/DD/YYY format. |
| HISTORY_TIME | The time the alarm was received by the system in HH:MM:SS format. |
| ACCOUNT_NUMBER | The subscriber account the alarm is assigned to (the account the alarm came in from). |
| INCIDENT_NUMBER | Unique identifier created by the system and assigned to the event. |
| HIST_TEXT | The alarm description written to account history. |
| COMPANY_NAME | The primary company name or the name of the individual responsible for the account. |
| HISTORY_EVENT_NTD | The time the alarm was received by the system in NTD format. |
| TYPE | The alarm code received. |
| TRACK_GROUPING | The operator track group this alarm type is assigned to. |
| CONTACT_LIST | The account (or dealer) contact list assigned to this alarm type. |
| TOTAL_RECORDS | The number of events retrieved by the request. |
Note: The NTD time is the date and time coded in a custom format. See the Date Format documentation for instructions on how to convert NTD to UNIX (and vice versa) as necessary.