Subscriber Record Reference

This documentation defines the subscriber record (ALSUBSCR) fields obtained when viewing subscriber information using the API. This record includes basic subscriber information and alarm handling protocols.

Example response

The following is an example of the ALSUBSCR response. The majority of the information displayed here exists within Data Entry on the subscriber.

    "ALSUBSCR": {
        "ACCOUNT_NUMBER": "00TEST",
        "COMPANY_NAME": "DICE Test Account",
        "SORT_BY_NAME": "test acct",
        "STREET_NO": "5555",
        "STREET_NAME1": "N",
        "STREET_NAME2": "Willow Avenue",
        "ADDTL_ADDRESS": "Apt 231",
        "CITY": "ALLENDALE",
        "STATE": "MI",
        "COUNTRY": "USA",
        "ZIPCODE": "49401",
        "IDENTIFIER_1": "TEST-1",
        "IDENTIFIER_2": "TEST-2",
        "IDENTIFIER_3": "TEST-3",
        "CROSS_STREET": "West Hemlock",
        "MISC_INFO_1": "Martin is filling in for Sarah",
        "MISC_INFO_2": "Additional information on the subscriber",
        "ANY_SIG_TEST": "Z",
        "LAST_SIG_TYPE": "BURG",
        "LAST_SIG_WHEN": "739504.38764",
        "ACTIVITY_DATE": "734979",
        "ACTIVATE": "Y",
        "DEALER": "00DLR",
        "TIME_ZN": "EST",
        "TEST_SPAN": "N",
        "LAST_REVISION": "739233.39597",
        "REVISION_OPR": "OPR",
        "ZONE_WILDCARDS": "Y",
        "START_DATE": "09/29/2014",
        "MAP": "MAP",
        "REGIONX": "REGX",
        "REGIONY": "REGY",
        "EXTENDED_SIGNALS": "Y",
        "ZONES_LINKED": "N",
        "USE_AREA": "N",
        "TWO_WAY": "Y",
        "PASSCODE_NEEDED": "Y",
        "SUPERVISE_SCHEDULE": "N",
        "STORM_MODE": "N",
        "TRACK_GROUPING": "ANDY",
        "M_BRANCH": "PRO",
        "CATCH_LATETO_ALARMS": "N",
        "EE_DELAY": "Y",
        "LAST_TEST_DATE": "736309.65257",
        "NTD_START_DATE": "735507",
        "COMMERCIAL_RESIDENTL": "R",
        "CONTACT_LIST_BY_AREA": "N",
        "LATITUDE": "57.841700000",
        "LONGITUDE": "-152.44308000",
        "COUNTY": "OTTAWA",
        "VOICE_IMMUNE": "N",
        "STORE_PASSCODE_PRINT": "Y",
        "GENERATE_SIG_ON_TEST": "N",
        "CUSTOM_ACCOUNT": "N",
        "FORCED_NOTES": "N"
    }

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.

Subscriber General

The General section of Data Entry contains basic subscriber information. The fields included within the ALSUBSCR record are defined below.

FieldDescription
ACCOUNT_NUMBERThe subscriber account number assigned upon creation.
ADDTL_ADDRESSAdditional address information such as P.O. box or apartment number.
ACTIVITY_DATEThe NTD time the first signal was received on the subscriber.
CITYThe city name of the subscriber’s address.
COMPANY_NAMEThe company name or the name of the individual responsible for the subscriber.
COUNTYThe name of the district or province where the subscriber is located.
COUNTRYThe country code of the subscriber’s address.
CROSS_STREETThe road name of the street running perpendicular to the subscriber’s location.
DEALERThe drealer number of the dealer responsible for the subscriber.
LAST_REVISIONThe NTD time when the subscriber was last edited or changed.
LAST_SIG_TYPEThe most recent signal type received.
LAST_SIG_WHENThe NTD time when the most recent signal was received.
LAST_TEST_DATEThe NTD time when the most recent test signal was received.
MISC_INFO_1Miscellaneous information field.
MISC_INFO_2Miscellaneous information field.
REVISION_OPRThe operator code of the individual who was responsible for the last revision.
SORT_BY_NAMEThe name the system will use when sorting the subscriber. This is the name users can use within account lookups when searching for the subscriber.
STATEThe state or province of the subscriber’s address.
STREET_NOThe building number of the subscriber’s address.
STREET_NAME1The street direction of the subscriber’s address.
STREET_NAME2The street name of the subscriber’s address.
TIME_ZNThe time zone the subscriber is located in.
ZIPCODEThe postal code of the subscriber’s address.

Subscriber Additional

The Additional tab within Data Entry contains identifiers and general signaling settings. The fields included within the ALSUBSCR record are defined below.

FieldDescription
ACTIVATEDetermines if the subscriber is currently active within the system.
COMMERCIAL_RESIDENTLDefines the property type of the subscriber. The available options are defined below.
CUSTOM_ACCOUNTDetermines if a notification stating the subscriber is custom will display upon viewing the subscriber within Data Entry.
FORCED_NOTESDetermines if operators will be prompted to answer a captcha to confirm they read all notes on the subscriber.
LATITUDEDetermines the latitude coordinates (distance of a place north or south of the earth’s equator) of the subscriber’s location.
LOGITUDEDetermines the longitude coordinate (distance of a place east or west of the meridian at Greenwich, England) of the subscriber’s location.
M_BRANCHThe ID of the monitoring branch the subscriber is assigned to.
MAPName of the map used to identify the location of the subscriber.
NTD_START_DATEThe NTD time the subscriber became active within the system.
PASSCODE_NEEDEDDetermines if operators are required to perform specific tasks while handling alarms for this subscriber.
REGIONXHorizontal coordinate of the subscriber on the specified map.
REGIONYVertical coordinate of the subscriber on the specified map.
START_DATEThe date the subscriber became active in the system.
STORE_PASSCODE_PRINTDetermines if contact passcodes can be printed using third-party software.
SUPERVISE_SCHEDULEDetermines how signals are handled during supervised schedules. The available options are defined below.
TRACK_GROUPINGDetermines the group of operators assigned to handle alarms received on the subscriber.
TWO_WAYDetermines if the subscriber will use DICE Two Way. Two Way functionality, when assigned, allows the subscriber to receive alarms via two way alarm panels (welfare pendants).
ZONES_LINKEDDetermines if zone information is mirrored between linked subscribers.

Commercial/Residential

OptionDefinition
AAnswering Service, a business that receives and answers phone calls for its clients.
CCommercial, a place of business.
RResidential, a private residence.
XOther, a property type not defined by the other options.

Supervise Schedule

OptionDefinition
AThe system will send all signals to operators for handling.
COnly close signals will be operator handled; all open signals will be system handled.
FOnly late-to signals are operator handled.
ISignals received from valid user IDs will be system handled. All other signals will be routed as determined by the subscriber’s assigned schedules.
NThe system will handle all open/close signals.
OOnly open signals will be operator handled; all close signals will be system handled.
PValid passcodes are required to validate users when handling signals. The supervised schedules are honored as configured.
UOnly signals with invalid user IDs are operator handled.
VOnly signals with unknown users are operator handled.
YThe system will honor supervised schedules and will generate the proper alarm signals as received.

Subscriber Handling

The Handling tab within Data Entry contains basic alarm handling parameters. The fields included within the ALSUBSCR record are defined below.

FieldDescription
CATCH_LATETO_ALARMSDetermines if late-to alarms are system handled given how their required alarm is received.
CONTACT_LIST_BY_AREADetermines if call lists will only notify contacts by their assigned areas.
EE_DELAYDetermines if signals can be delayed on the subscriber.
GENERATE_SIG_ON_TESTDetermines if the subscriber will automatically send a DISAB signal when placed on test within the system.
STORM_MODEDetermines if the subscriber’s signals are exempt from storm mode system handling.
USE_AREADetermines if areas will be used on the subscriber. Areas are used to determine different sections within zones and schedules on the subscriber.
VOICE_IMMUNEDetermines if the subscriber can be contacted by Outbound Voice.
ZONE_WILDCARDSDetermines if the subscriber uses wildcards when defining zone information.

Subscriber Timers

The Timers tab within Data Entry contains testing signal parameters. The fields included within the ALSUBSCR record are defined below.

FieldDescription
ANY_SIG_TESTDefines which test signals the system should expect from the subscriber. The available options are defined below.
TEST_SPANThe amount of time that is expected to elapse between test signals. The available options are defined below.

Any Signal a Test options

OptionDefinition
NNo, only valid test signals received on the subscriber should be handled as test signals.
YYes, any signal received on the subscriber should be handled as a test signal.
ZTesting signals will be determined zone-by-zone. See the Timers documentation for more information on zone test options.

Test Span options

OptionDefinition
DSets the test span to 1 full day between signals. All test signals using this span type will be system handled.
HHourly. 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.
MSets the test span to 1 full month (28 days) between signals. All test signals using this span type will be system handled.
NNever. Test signals are not expected on the subscriber.
QSets the test span to 1 yearly quarter (90 days) between test signals. All test signals using this span type will be system handled.
WSets the test span to 1 full week (7 days) between signals. All test signals using this span type will be system handled.

Subscriber Identifiers

The Identifiers tab within Data Entry contains miscellaneous subscriber identifier fields uses to define additional information on the subscriber. The fields included within the ALSUBSCR record are defined below.

FieldDescription
IDENTIFIER_1Miscellaneous information field.
INDENTIFIER_2Miscellaneous information field.
IDENTIFIER_3Miscellaneous information field.
← Get Started
Supplemental Information →