Remote Monitoring

This documentation will describe the Remote Monitoring (XMMOMINI) endpoint. This endpoint allows users to view and manage pending alarms within Remote Monitoring.

See the Authentication documentation for information on how to obtain the authentication headers within the request.

Use cases

View Remote Monitoring pending alarms
Log alarms within Remote Monitoring
View susbscriber information

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.

View Pending

Get a list of all alarms currently within the Remote Monitoring pending queue.

Supported attributes

Attribute	Type	Required	Description
*setMethod	string	Yes	Determines the endpoint you are calling. Must be `XMMOMINI` to view alarm information.
OPTION	string	Yes	Determines the method you will be using. Use `PENDING` 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="XMMOMINI"' \
--form 'OPTION="PENDING"'

Example response

{
    "ALPNDLPQ": [
        {
            "DEALER": " KEVIN",
            "PRIORITY": "C",
            "PASSCODE_VERIFIED": "N",
            "PENDING_TIME": "739064.42899",
            "INCIDENT_NUMBER": "    7825",
            "ACCOUNT_NUMBER": "  01KEVIN",
            "COMPANY_NAME": "WWWWWWWWWWWWWWWWWWWWWWWWW",
            "HISTORY_EVENT_NTD": "739064.42899",
            "FIRST_ZONE": "ACCNTRUNA",
            "TYPE": "RUNAW ",
            "CREATE_TICKET": "N",
            "SEIA_CODE": "RUNSY ",
            "SEIA_MESSAGE": "- 01KEVIN 10 SIGS IN 2 MIN    ",
            "SEIA_CONDITION": "RNWY LVL-SYS                  ",
            "CONTACT_LIST": "NOTIFY",
            "ALARM_CATEGORY": "N",
            "AUDIBLE_SILENT": "A",
            "SPECIAL_SIGNAL": "#",
            "SIGNAL_REQUIRES": "O"
        },
        {
            "DEALER": "KEVIN",
            "PRIORITY": "C",
            "PASSCODE_VERIFIED": "N",
            "PENDING_TIME": "739130.34846",
            "INCIDENT_NUMBER": "225489",
            "ACCOUNT_NUMBER": "r00KEVIN",
            "COMPANY_NAME": "<b>Kevin's Construction <",
            "HISTORY_EVENT_NTD": "739130.34846",
            "FIRST_ZONE": "E100",
            "TYPE": "MEDIC",
            "CREATE_TICKET": "N",
            "SEIA_CODE": "E100",
            "SEIA_MESSAGE": "ZONE",
            "SEIA_CONDITION": "MEDICAL",
            "CONTACT_LIST": "MEDIC",
            "ALARM_CATEGORY": "N",
            "AUDIBLE_SILENT": "S",
            "SIGNAL_REQUIRES": "O",
            "RESET_FR_ZONE": "R100",
            "STREET_NO": "1204    ",
            "STREET_NAME1": "N ",
            "STREET_NAME2": "BAY RD1                     ",
            "CITY": "BAY CITY7         ",
            "STATE": "AK ",
            "ZIPCODE": "49401     "
        },
        {
            "DEALER": "KEVIN",
            "PRIORITY": "D",
            "PASSCODE_VERIFIED": "N",
            "PENDING_TIME": "738896.49402",
            "INCIDENT_NUMBER": "198303",
            "ACCOUNT_NUMBER": "00KEVIN",
            "COMPANY_NAME": "<b>Kevin's Construction <",
            "HISTORY_EVENT_NTD": "738896.49402",
            "FIRST_ZONE": "E1301",
            "TYPE": "BURG",
            "CREATE_TICKET": "N",
            "SEIA_CODE": "E130",
            "SEIA_MESSAGE": "BURGLARY",
            "SEIA_ZONE": "A",
            "TEMP_PHONE": "GPS|URL",
            "CONTACT_LIST": "BURG",
            "ALARM_CATEGORY": "N",
            "AUDIBLE_SILENT": "A",
            "SIGNAL_REQUIRES": "O",
            "TRACK_GROUPING": "ANDY",
            "RESET_FR_ZONE": "R1301",
            "PREV_TYPE": "1",
            "STREET_NO": "1204    ",
            "STREET_NAME1": "N ",
            "STREET_NAME2": "BAY RD1                     ",
            "CITY": "ALLENDALE         ",
            "STATE": "MI ",
            "ZIPCODE": "49401     "
        }
    ]
}

Load Subscriber

View subscriber information. See the Subscriber Record Reference documentation for detailed definitions of the ALSUBSCR fields.

Supported attributes

Attribute	Type	Required	Description
*setMethod	string	Yes	Determines the endpoint you are calling. Must be `XMMOMINI` to view subscriber information.
OPTION	string	Yes	Determines the method you will be using. Use `LOAD` to view subscribers.
ACCOUNT_NUMBER	string	Yes	Defines the subscriber account number (`9` character max).

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="XMMOMINI"' \
--form 'OPTION="LOAD"' \
--form 'ACCOUNT_NUMBER="00KEVIN"'

Example response

{
    "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"
    },
    "ALCONCT": [
        {
            "ACCOUNT_NUMBER": "00KEVIN",
            "DEFAULT_LIST_NO": "00",
            "CONTACT_NAME": " Kevin's Demolit",
            "CONTACT_PHONE": "(555) 555-4221",
            "CONT_BEG_DATE": "000000",
            "CONT_END_DATE": "999999",
            "CONT_BEG_TIME": "0000",
            "CONT_END_TIME": "2400",
            "PERSONAL_INFO": "PREMISES PHONE NUMBER",
            "CHANGED_DATE": "05/16/2024",
            "CHANGED_OPR": "KK",
            "LANGUAGE": "EN",
            "MODIFY_OWN_DATA": "A",
            "PAGER_YN": "N",
            "CONTACT_TYPE": "05",
            "CONTACT_PHONE_F": "!",
            "SORT_PHONE": "5555554221",
            "NO_AREA_CODE_SORT": "5554221"
        }
    ],
    "SVACTIMG": {
        "ACCOUNT_NUMBER": "00KEVIN",
        "IMAGE_PATH": "/web/images/1431535729.2268.png",
        "EXTENSION": "png",
        "DOC_TYPE": "HTTPSI",
        "DOC_NAME": "subscriber_photo"
    }
}

Log Alarm

Log an existing pending alarm.

Supported attributes

Attrinbute	Type	Required	Description
*setMethod	string	Yes	Determines the endpoint you are calling. Must be `XMMOMINI` to log alarms.
OPTION	string	Yes	Determines the method you will be using. Use `LOG` to log an alarm.
ACCOUNT_NUMBER	string	Yes	Defines the subscriber account number the alarm is assgined to (`9` character max).
DEALER	string	Yes	Defines the account number of the deal that manages the subscriber (`6` character max).
PRIORITY	string	Yes	Defines the importance level assigned to the alarm (`1` character max).
PASSCODE_VERIFIED	string	Yes	Defines if a passcode was verified for the alarm (`1` character max).
PENDING_TIME	string	Yes	Defines the NTD time the alarm was delivered to pending.
INCIDENT_NUMBER	string	Yes	Defines the unique identifier created by the system and assigned to the event.

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="XMMOMINI"' \
--form 'OPTION="LOG"' \
--form 'ACCOUNT_NUMBER="00KEVIN"' \
--form 'DEALER=" KEVIN"' \
--form 'PRIORITY="B"' \
--form 'PASSCODE_VERIFIED="N"' \
--form 'PENDING_TIME="739064.42903"' \
--form 'INCIDENT_NUMBER="  221855"'

Example response

{
    "READING_ALPNDLPQ": " KEVINBN739064.42903  221855"
}

Remote Monitoring

Use cases #

Date formats #

View Pending #

Supported attributes #

Example request #

Example response #

Load Subscriber #

Supported attributes #

Example request #

Example response #

Log Alarm #

Supported attributes #

Example request #

Example response #

Use cases

Date formats

View Pending

Supported attributes

Example request

Example response

Load Subscriber

Supported attributes

Example request

Example response

Log Alarm

Supported attributes

Example request

Example response