Subscriber Record

This documentation defines the Subscriber Record (ALSUBSCR) 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

#	Name	Description	Length	Padding Type
1	ACCOUNT_NUMBER	The subscriber account number assigned upon creation.	9	Right justify data and pad with leading spaces.
2	COMPANY_NAME	The company name or the name of the individual responsible for the subscriber.	28	Pad with trailing spaces.
3	SORT_BY_NAME	The name the system will use when sorting the subscriber. This is the name users can use within account lookups when searching for the subscriber.	15	Pad with trailing spaces.
4	STREET_NO	The building number of the subscriber’s address.	8	Pad with trailing spaces.
5	STREET_NAME1	The street direction of the subscriber’s address.	2	Pad with trailing spaces.
6	STREET_NAME2	The street name of the subscriber’s address.	28	Pad with trailing spaces.
7	ADDTL_ADDRESS	Additional address information such as P.O. box or apartment number.	28	Pad with trailing spaces.
8	CITY	The city name of the subscriber’s address.	18	Pad with trailing spaces.
9	STATE	The state or province abbreviation of the subscriber’s address.	3	Pad with trailing spaces.
10	COUNTRY	The country code of the subscriber’s address.	3	Pad with trailing spaces.
11	ZIPCODE	The postal code of the subscriber’s address.	10	Pad with trailing spaces.
12	IDENTIFIER_1	Miscellaneous information field.	9	Pad with trailing spaces.
13	IDENTIFIER_2	Miscellaneous information field.	9	Pad with trailing spaces.
14	IDENTIFIER_3	Miscellaneous information field.	9	Pad with trailing spaces.
15	PANEL_TYPE	The brand/model of the alarm panel used on the account.	10	Pad with trailing spaces.
16	CROSS_STREET	The road name of the street running perpendicular to the subscriber’s location.	32	Pad with trailing spaces.
17	MISC_INFO_1	Miscellaneous information field.	39	Pad with trailing spaces.
18	MISC_INFO_2	Miscellaneous information field.	39	Pad with trailing spaces.
19	ANY_SIG_TEST	Determines which test signals the system should expect from the subscriber. The available options are defined below.	1	Pad with trailing spaces.
20	LAST_SIG_TYPE	The most recent signal type received.	6	Pad with trailing spaces.
21	LAST_SIG_ZONE	The zone the most recent signal was received on.	3	Pad with trailing spaces.
22	LAST_SIG_WHEN	The NTD time when the most recent signal was received.	12	Pad with trailing spaces.
23	ACTIVITY_DATE	The NTD time the first signal was received on the subscriber.	12	Pad with trailing spaces.
24	ACTIVATE	Determines if the subscriber is currently active within the system.	1	Pad with trailing spaces.
25	INACT_DATE	The date the subscriber was deactivated within the system (MM/DD/YY format).	6	Pad with trailing spaces.
26	UL_GRADE	The account’s UL Grade as input by an administrator.	2	Pad with trailing spaces.
27	DEALER	The Dealer account number of the Dealer responsible for the subscriber.	6	Right justify data and pad with leading spaces.
28	DEFAULT_ZONE	The list of zones assigned to the subscriber. Default Zones are groups of zones defined on the Dealer account.	6	Pad with trailing spaces.
29	TIME_ZN	The time zone the subscriber is located in.	3	Pad with trailing spaces.
30	TEST_SPAN	The amount of time that is expected to elapse between test signals. The available options are defined below.	1	Pad with trailing spaces.
31	LAST_REVISION	The NTD time when the subscriber was last edited or changed.	12	Pad with trailing spaces.
32	REVISION_OPR	The operator code of the individual who was responsible for the last revision.	3	Pad with trailing spaces.
33	ZONE_WILDCARDS	Determines if the subscriber uses wildcards when defining zone information.	1	Pad with trailing spaces.
34	KEY_NUMBER	Also known as the `IDENTIFIER_4` field. Miscellaneous information field.	15	Pad with trailing spaces.
35	START_DATE	The date the subscriber became active in the system.	6	Pad with trailing spaces.
36	MAP	The name assigned to the map used to identify the location of the subscriber.	6	Pad with trailing spaces.
37	REGIONX	The horizontal coordinate of the subscriber on the specified map.	5	Pad with trailing spaces.
38	REGIONY	The vertical coordinate of the subscriber on the specified map.	5	Pad with trailing spaces.
40	RADIO_LINK	If applicable, the account number of the subscriber linked to the viewed subscriber.	9	Right justify data and pad with leading spaces.
41	ZONES_LINKED	Determines if zone information is mirrored between linked subscribers.	1	Pad with trailing spaces.
42	USE_AREA	Determines if areas will be used on the subscriber.	1	Pad with trailing spaces.
43	TWO_WAY	Determines if the subscriber will use DICE Two Way.	1	Pad with trailing spaces.
44	PASSCODE_NEEDED	Determines if operators are required to perform specific tasks while handling alarms for this subscriber.	1	Pad with trailing spaces.
45	SUPERVISE_SCHEDULE	Determines how signals are handled during supervised schedules. The available options are defined below.	1	Pad with trailing spaces.
46	STORM_MODE	Determines if the subscriber’s signals are exempt from storm mode system handling.	1	Pad with trailing spaces.
47	TRACK_GROUPING	The group of operators assigned to handle alarms received on the subscriber.	6	Pad with trailing spaces.
48	LANGUAGE	The abbreviation of the language used by the subscriber.	2	Pad with trailing spaces.
49	I_BRANCH	The ID of the install branch assigned to the subscriber.	3	Pad with trailing spaces.
50	M_BRANCH	The ID of the monitoring branch assigned to the subscriber.	3	Pad with trailing spaces.
51	B_BRANCH	The ID of the billing branch assigned to the subscriber.	3	Pad with trailing spaces.
52	S_BRANCH	The ID of the service branch assigned to the subscriber.	3	Pad with trailing spaces.
53	SITE_SALES_TAX_GROUP	The ID of the sales tax code assigned to the subscriber.	6	Pad with trailing spaces.
54	SITE_SALESREP_GROUP	The ID of the sales rep group assigned to the subscriber.	6	Pad with trailing spaces.
57	SERVICE_CODE	The service plan assigned to the subscriber.	6	Pad with trailing spaces.
58	GEO_CODE	Also known as the `IDENTIFIER_5` field. Miscellaneous information field.	12	Pad with trailing spaces.
59	BLANKET_PO_NUMBER	Also known as the `IDENTIFIER_6` field. Miscellaneous information field.	15	Pad with trailing spaces.
60	CATCH_LATETO_ALARMS	Determines if late-to alarms are system-handled based on how the corresponding required alarm was received.	1	Pad with trailing spaces.
61	EE_DELAY	Determines if signals can be delayed on the subscriber.	1	Pad with trailing spaces.
62	LAST_TEST_DATE	The NTD time when the most recent test signal was received.	12	Pad with trailing spaces.
65	NTD_START_DATE	The NTD time the subscriber became active within the system.	6	Pad with trailing spaces.
66	COMMERCIAL_RESIDENTL	Defines the property type of the subscriber. The available options are defined below.	1	Pad with trailing spaces.
67	ADDTL_ADDRESS_2	Additional address information for international accounts.	28	Pad with trailing spaces.
68	ADDTL_ADDRESS_3	Additional address information for international accounts.	28	Pad with trailing spaces.
69	RATE_TABLE	If using Dealer Billing, the rate structure used by the subscriber.	6	Pad with trailing spaces.
70	DELAY_SIGNALS	Determines the number of seconds all signals received on the account will be delayed.	3	Pad with trailing spaces.
71	CONTACT_LIST_BY_AREA	Determines if call lists will only notify contacts by their assigned areas.	1	Pad with trailing spaces.
72	GLOBAL_CHART_LIST	If applicable, defines the chart code override list this account should use. Chart Lists are managed within CORE.	6	Right justify data and pad with leading spaces.
73	LATITUDE	The latitude coordinates (distance of a place north or south of the earth’s equator) of the subscriber’s location.	12	Pad with trailing spaces.
74	LONGITUDE	The longitude coordinate (distance of a place east or west of the meridian at Greenwich, England) of the subscriber’s location.	12	Pad with trailing spaces.
75	COUNTY	The name of the district or province where the subscriber is located.	35	Pad with trailing spaces.
76	VOICE_IMMUNE	Determines if the subscriber can be contacted by Outbound Voice.	1	Pad with trailing spaces.
77	STORE_PASSCODE_PRINT	Determines if contact passcodes can be printed using third-party software.	1	Pad with trailing spaces.
78	GENERATE_SIG_ON_TEST	Determines if the subscriber will automatically send a `DISAB` signal when placed on test within the system.	1	Pad with trailing spaces.
81	CUSTOM_ACCOUNT	Determines if a notification stating the subscriber is custom will display upon viewing the subscriber within Data Entry.	1	Pad with trailing spaces.
82	FORCED_NOTES	Determines if operators will be prompted to answer a captcha to confirm they read all notes on the subscriber.	1	Pad with trailing spaces.
83	USES_CVR	Determines if the subscriber has one or more recording devices (cameras or NVRs) entered on their account.	1	Pad with trailing spaces.

Any Signal is a Test options

Option	Definition
`N`	No, only valid test signals received on the subscriber should be handled as test signals.
`Y`	Yes, any signal received on the subscriber should be handled as a test signal.
`Z`	Testing signals will be determined zone-by-zone. See the Timers documentation for more information on zone test options.

Test Span options

Option	Definition
`D`	Sets the test span to `1` full day between signals. All test signals using this span type will be system handled.
`H`	Hourly. Allows users to define the precise amount of time the system should expect to elapse between testing signals on the subscriber. See the Timers documentation for more information on configuring hourly test spans.
`M`	Sets the test span to `1` full month (28 days) between signals. All test signals using this span type will be system handled.
`N`	Never. Test signals are not expected on the subscriber.
`Q`	Sets the test span to `1` yearly quarter (90 days) between test signals. All test signals using this span type will be system handled.
`W`	Sets the test span to `1` full week (7 days) between signals. All test signals using this span type will be system handled.

Supervise Schedule options

Option	Definition
`A`	The system will send all signals to operators for handling.
`C`	Only close signals will be operator handled; all open signals will be system handled.
`F`	Only late-to signals are operator handled.
`I`	Signals received from valid user IDs will be system handled. All other signals will be routed as determined by the subscriber’s assigned schedules.
`N`	The system will handle all open/close signals.
`O`	Only open signals will be operator handled; all close signals will be system handled.
`P`	Valid passcodes are required to validate users when handling signals. The supervised schedules are honored as configured.
`U`	Only signals with invalid user IDs are operator handled.
`V`	Only signals with unknown users are operator handled.
`Y`	The system will honor supervised schedules and will generate the proper alarm signals as received.

Commercial/Residential options

Option	Definition
`A`	Answering Service, a business that receives and answers phone calls for its clients.
`C`	Commercial, a place of business.
`R`	Residential, a private residence.
`X`	Other, a property type not defined by the other options.

Example request

curl --request GET \
--url 'https://global-rest.ci.matrixmcloud.com/rest/rest.php?dataSource=dice&*view=alsubscr&*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

{
  "ALSUBSCR": [
    {
      "ACCOUNT_NUMBER": "        2",
      "COMPANY_NAME": "TEST ACCT",
      "SORT_BY_NAME": "COMPANY PLACE",
      "STREET_NO": "301",
      "STREET_NAME1": "E",
      "STREET_NAME2": "COMMERCIAL DR",
      "ADDTL_ADDRESS": "BLDG #A1111",
      "CITY": "BAY CITY",
      "STATE": "MI",
      "COUNTRY": "USA",
      "ZIPCODE": "48708",
      "IDENTIFIER_1": "BURG",
      "IDENTIFIER_2": "TESTING",
      "IDENTIFIER_3": "",
      "PANEL_TYPE": "",
      "CROSS_STREET": "",
      "MISC_INFO_1": "WATCH OUT FOR THE BIG DOG    !",
      "MISC_INFO_2": "",
      "ANY_SIG_TEST": "Z",
      "LAST_SIG_TYPE": "NOTIFY",
      "LAST_SIG_ZONE": "",
      "LAST_SIG_WHEN": "739008.55961",
      "ACTIVITY_DATE": "734760",
      "ACTIVATE": "Y",
      "INACT_DATE": "",
      "UL_GRADE": "",
      "DEALER": "    ME",
      "DEFAULT_ZONE": "",
      "TIME_ZN": "EST",
      "TEST_SPAN": "N",
      "LAST_REVISION": "739681.35711",
      "REVISION_OPR": "NW",
      "ZONE_WILDCARDS": "N",
      "KEY_NUMBER": "",
      "START_DATE": "11/23/14",
      "MAP": "MAP",
      "REGIONX": "REGX",
      "REGIONY": "REGY",
      "EXTENDED_SIGNALS": "N",
      "RADIO_LINK": "NW0000000",
      "ZONES_LINKED": "C",
      "USE_AREA": "Y",
      "TWO_WAY": "N",
      "PASSCODE_NEEDED": "Y",
      "SUPERVISE_SCHEDULE": "Y",
      "STORM_MODE": "N",
      "TRACK_GROUPING": "GRP1",
      "LANGUAGE": "",
      "I_BRANCH": "PRO",
      "M_BRANCH": "XXZ",
      "B_BRANCH": "PRO",
      "S_BRANCH": "PRO",
      "SITE_SALES_TAX_GROUP": "",
      "SITE_SALESREP_GROUP": "",
      "CURRENT_JOB_NUMBER": "",
      "JOB_TYPE": "2-RSHP",
      "SERVICE_CODE": "",
      "GEO_CODE": "",
      "BLANKET_PO_NUMBER": "KEYWRITER",
      "CATCH_LATETO_ALARMS": "Y",
      "EE_DELAY": "Y",
      "LAST_TEST_DATE": "739008.53793",
      "BILLING_STATUS": "R",
      "MIN_EDITOR_LEVEL": "",
      "NTD_START_DATE": "735562",
      "COMMERCIAL_RESIDENTL": "C",
      "ADDTL_ADDRESS_2": "",
      "ADDTL_ADDRESS_3": "",
      "RATE_TABLE": "",
      "DELAY_SIGNALS": "",
      "CONTACT_LIST_BY_AREA": "Y",
      "GLOBAL_CHART_LIST": " ULSIA",
      "LATITUDE": "43.559572000",
      "LONGITUDE": "-83.820876000",
      "COUNTY": "BAY",
      "VOICE_IMMUNE": "Y",
      "STORE_PASSCODE_PRINT": "N",
      "GENERATE_SIG_ON_TEST": "N",
      "INACT_TIME": "",
      "TEMP_NOTE_NOTIFY_DAY": "",
      "CUSTOM_ACCOUNT": "N",
      "FORCED_NOTES": "N",
      "USES_CVR": "",
      "USED_NOT88": "",
      "USED_NOT89": "",
      "USED_NOT90": ""
    }
  ],
  "totalRecords": 1
}

Subscriber Record

Date formats #

Field definitions #

Any Signal is a Test options #

Test Span options #

Supervise Schedule options #

Commercial/Residential options #

Example request #

Example response #