Subscriber History Record

This documentation defines the Subscriber History Record (ALTRANHD) schema fields.

Please Note This documentation defines the most relevant fields. Treat the response from the View Table Schema (XMGETFMT) endpoint as the authoritative field list for any specific site.

Date formats

NTD is a timestamp format used by DICE. NTD dates are used when defining time frames within endpoint calls. See the Date Format documentation for information on converting NTD to UNIX and vice versa if needed.

Field definitions

#NameDescriptionLengthPadding Type
1ACCOUNT_NUMBERThe subscriber account number assigned upon creation.9Right justify data and pad with leading spaces.
2HISTORY_EVENT_NTDThe NTD timestamp of when the history event occurred.12Pad with trailing spaces.
3INCIDENT_NUMBERUnique identifier created by the system and assigned to the event.8Pad with trailing spaces.
4SEIA_CODEIf applicable, the SEIA alarm code.5Pad with trailing spaces.
5ZONE_CODE_1The zone code sent by the panel.6Pad with trailing spaces.
6ZONE_CODE_2The zone or user that was sent. The SECOND_ZONE_IS field determines whether it was processed as a zone or a user.6Pad with trailing spaces.
7AREAIf applicable, the area that was sent by the panel.3Pad with trailing spaces.
8TYPETThe alarm code received.6Pad with trailing spaces.
9OPRThe operator code of the individual who handled the alarm.3Pad with trailing spaces.
10ALARM_CATEGORYThe category assigned to the alarm. See the Alarm Category documentation for descriptions of the available categories.1Pad with trailing spaces.
11PRIORITYThe importance assigned to the alarm type.1Pad with trailing spaces.
12HIST_TEXTThe alarm description written to account history.50Pad with trailing spaces.
13ALARM_RESOLUTIONIf applicable, the resolution code applied to the alarm.2Pad with trailing spaces.
14AM_NOTIFYIf applicable, indicates whether a notification was sent for this event.1Pad with trailing spaces.
15DUPLICATE_SIGSThe number of duplicate signals received for this event.3Pad with trailing spaces.
16PENDING_TIMEThe NTD time the alarm was delivered to pending.12Pad with trailing spaces.
17PR_CHECKSUMA checksum value used to audit the integrity of the event record.3Pad with trailing spaces.
18SECOND_ZONE_ISDetermines whether the value in ZONE_CODE_2 was processed as a zone or a user.1Pad with trailing spaces.

Example request 

curl --request GET \
--url 'https://example.securemcloud.com/rest/rest.php?dataSource=dice&*view=altranhd&*limit=1&*blanks=all' \
--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' \

Example response 

{
  "ALTRANHD": [
    {
      "ACCOUNT_NUMBER": "        C",
      "HISTORY_EVENT_NTD": "739807.56560",
      "INCIDENT_NUMBER": "!!06565.",
      "SEIA_CODE": "",
      "ZONE_CODE_1": "",
      "ZONE_CODE_2": "",
      "AREA": "",
      "TYPE": "AUDIT",
      "OPR": "NW",
      "ALARM_CATEGORY": "N",
      "PRIORITY": "",
      "HIST_TEXT": "AUDIT DETAILS FOR Contact Call List",
      "ALARM_RESOLUTION": "",
      "AM_NOTIFY": "",
      "DUPLICATE_SIGS": "",
      "PENDING_TIME": "739807.56560",
      "PR_CHECKSUM": 0,
      "SECOND_ZONE_IS": ""
    }
  ],
  "totalRecords": 1
}
← Recurring Line Notes