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 when needed.

View pending

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

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMMOMINI to view alarm information.
OPTIONstringYesDetermines 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     "
        }
    ]
}

Response fields

FieldDescription
DEALERThe dealer account that manages the subscriber account
PRIORITYThe importance assigned to the alarm type.
PASSCODE_VERIFIEDWhether or not a passcode was verified on the alarm.
PENDING_TIMEThe NTD time the alarm was delivered to pending.
INCIDENT_NUMBERUnique identifier created by the system and assigned to the event.
ACCOUNT_NUMBERThe subscriber’s Matrix account number.
COMPANY_NAMEThe primary company name or the name of the individual responsible for the account.
HISTORY_EVENT_NTDThe NTD time the alarm was received by the system.
FIRST_ZONEThe zone code sent by the panel.
TYPEThe alarm code received.
CREATE_TICKETWhether or not this alarm type should create a ticket in the system.
SEIA_CODEIf applicable, the SEIA alarm code.
SEIA_MESSAGEIf applicable, the SEIA message text associated with the alarm.
SEIA_CONDITIONIf applicable, provides additional zone information.
CONTACT_LISTThe account (or dealer) contact list assigned to this alarm type.
ALARM_CATEGORYThe category assigned to the alarm. See the Alarm Category documentation for descriptions of the available categories.
AUDIBLE_SILENTWhether or not the alarm emits sound when tripped.
SPECIAL_SIGNALAdditional information regarding the alarm. The available descriptors are defined below.
SIGNAL_REQUIRESHow the system is configured to handle the alarm. More information on the possible handling protocols can be found below.
RESET_FR_ZONEThe restore code associated with the alarm.
STREET_NOThe number associated with the subscriber’s address.
STREET_NAME1If applicable, the street direction associated with the subscriber’s address.
STREET_NAME2The name of the road associated with the subscriber’s address.
CITYThe city/town associated with the subscriber’s address.
STATEThe state/province abbreviation associated with the subscriber’s address.
ZIPCODEThe postal code associated with the subscriber’s address.
Special signal options
OptionDefinition
AAM Notify alarm.
EFax expired.
#The alarm description was obtained from the panel.
!The zone information was obtained from the dealer zone.
DReminder alarm.
CHold expired.
BOperator not responding.
Signal requires options
OptionDefinition
OOperator Handled. When received, the alarm will be sent to operators for handling.
PPasscode. When received, the alarm will be sent to operators for handling and require responding parties to provide a valid passcode prior to allowing the operator to complete handling the alarm.
SSystem Handled. When received, the alarm will be automatically handled and logged to history by the system.
CCondition. When received, alarms follow the account’s supervised schedule. If the account is labeled as closed, operators will receive the alarm for handling. If the account is labeled as open, alarms will be automatically handled by the system.
TTicket. When received, the alarm will generate a service ticket within the system. The original alarm is system handled.
AConditionally System Handle. When received, alarms are system handled on the condition that the area is open.
BConditionally System Handle. Alarms received are system handled on the condition that the area is closed.

Load Subscriber

View subscriber information.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMMOMINI to view subscriber information.
OPTIONstringYesDetermines the method you will be using. Use LOAD to view subscribers.
ACCOUNT_NUMBERstringYesDefines 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 ",
        "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"
    }
}

ALSUBSCR response fields

FieldDescription
ACCOUNT_NUMBERThe subscriber account number.
COMPANY_NAMEThe primary company name or the name of the individual responsible for the account.
SORT_BY_NAMEThe name the system will use when sorting account information. This is the name users can use within account lookups when trying to find the account.
STREET_NOThe numerical part of the subscriber’s address.
STREET_NAME1The street direction of the subscriber’s address.
STREET_NAME2The name of the street of the subscriber’s address.
ADDTL_ADDRESSAdditional address information such as P.O. box or apartment number.
CITYThe city name of the subscriber’s location.
STATEThe state or province of the subscriber’s location.
COUNTRYThe country abbreviation of the subscriber’s location.
ZIPCODEThe postal code of the subscriber’s location.
IDENTIFIER_1Miscellaneous information field.
INDENTIFIER_2Miscellaneous information field.
IDENTIFIER_3Miscellaneous information field.
CROSS_STREETThe road name of the street running perpendicular to the subscriber’s primary street location.
MISC_INFO_1Miscellaneous information field.
MISC_INFO_2Miscellaneous information field.
ANY_SIG_TESTDefines what signals the system should expect from the account as test signals.
LAST_SIG_TYPEThe most recent signal received on the subscriber account.
LAST_SIG_WHENThe NTD time the most recent signal was received on the subscriber account.
ACTIVITY_DATEThe NTD time the first signal was received on the subscriber account.
ACTIVATEDetermines if the account is currently active within the system.
DEALERThe dealer account responsible for the subscriber.
TIME_ZNThe time zone the subscriber is located in.
TEST_SPANThe amount of time that is expected to elapse between test signals.
LAST_REVISIONThe NTD time the subscriber account was last edited or changed.
REVISION_OPRThe operator code of the individual who was responsible for the last revision.
ZONE_WILDCARDSDetermines if the subscriber uses wildcards when defining zone information.
START_DATEThe date the subscriber became active in the system.
MAPName of the map used to identify the location of the subscriber.
REGIONXHorizontal coordinate of the subscriber on the specified map.
REGIONYVertical coordinate of the subscriber on the specified map.
ZONES_LINKEDDetermines if zone information is mirrored between linked accounts.
USE_AREADetermines if areas will be used on the subscriber. Areas are used to determine different sections within zones and schedules on the subscriber.
TWO_WAYDetermines if the subscriber will use DICE Two Way. Two Way functionality, when assigned, allows the account to receive alarms via two way alarm panels (lwelfare pendants).
PASSCODE_NEEDEDDetermines if operators are required to perform specific tasks while handling alarms for this subscriber.
SUPERVISE_SCHEDULEDetermines how signals are handled during supervised schedules. The available options are defined below.
STORM_MODEDetermines if the subscriber’s signals are exempt from storm mode system handling.
TRACK_GROUPINGDetermines the group of operators assigned to handle alarms received on the subscriber.
I_BRANCHThe ID of the installation branch the subscriber is assgined to.
M_BRANCHThe ID of the monitoring branch the subscriber is assigned to.
B_BRANCHThe ID of the billing branch the subscriber is assigned to.
S_BRANCHThe ID of the service branch the subscriber is assigned to.
BLANKET_PO_NUMBERThe purchase order number used by the subscriber.
CATCH_LATETO_ALARMSDetermines if late-to alarms are system handled given how their required alarm is received.
EE_DELAYDetermines if an entry/exit delay will be used when arming/disarming zones.
LAST_TEST_DATEThe NTD time of the most recent test signal received on the subscriber account.
NTD_START_DATEThe NTD time the subscriber became active within the sytem.
COMMERCIAL_RESIDENTLDefines the property type of the subscriber. The available options are defined below.
CONTACT_LIST_BY_AREADetermines if call lists will only notify contact by their assigned areas.
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.
COUNTYDefines the name of the district or province where the subscriner is located.
VOICE_IMMUNEDetermines if the subscriber can be contacted by Outbound Voice.
STORE_PASSCODE_PRINTDetermines if contact passcodes can be printed using third-party software.
GENERATE_SIG_ON_TESTDetermines if the subscriber account will automatically send a DISAB signal when placed on test within the system.
CUSTOM_ACCOUNTDetermines if a notification stating the subscriber is custom will display upon viewing Account Information within Data Entry.
FORCED_NOTESDetermines if operators will be prompted to answer a captcha to confirm they read all notes on the subscriber.
Supervise Schedule options
OptionDefinition
AThe system will send all signals to operators for handling.
NThe system will handle all open/close signals.
YThe system will honor supervised schedules and will generate the proper alarm signals as received.
ISignals received from valid user IDs will be system handled. All other signals will be routed as determined by the account’s assigned schedules.
UOnly signals with invalid user IDs are operator handled.
FOnly late-to signals are operator handled.
VOnly signals with unknown users are operator handled.
OOnly open signals will be operator handled; all close signals will be system handled.
COnly close signals will be operator handled; all open signals will be system handled.
PValid passcodes are required to validate users when handling signals. The supervised schedules are honored as configured.
Commercial Restidental options
OptionDefinition
CCommercial customer, a place of business.
RResidential customer, a private residence.
XOther customer, a property type not defined by the other options.
AAnswering Service customer, a business that receives and answers phone calls for its clients.

ALCONCT response fields

FieldDescription
ACCOUNT_NUMBERThe subscriber account number.
DEFAULT_LIST_NODisplays the identifier assigned to the contact upon creation.
CONTACT_NAMEDisplays the contact’s first and last name.
CONTACT_PHONEDisplays the contact’s prumary phone number.
CONT_BEG_DATEDisplays the date the contact begins being valid within the system.
CONT_END_DATEDisplays the date the contact stops being valid within the system.
CONT_BEG_TIMEDisplays the time (on the CONT_BEG_DATE) the contact beings being valid within the system.
CONT_END_TIMEDisplays the time (on the CONT_END_DATE) the contact stops being valid within the system.
PERSONAL_INFODisplays any miscellaneous information data entered on the contact.
CHANGED_DATEDisplays the date the contact was last updated.
CHANGED_OPRDisplays the operator responsible for the most recent change to the contact.
LANGUAGEDisplys the language spoken by the contact.
MODIFY_OWN_DATADisplays the contact’s contact data management privileges. The available options are defined below.
PAGER_YNDisplays if the contact has pager information assigned to their profile.
CONTACT_TYPEDisplays the category the contact falls into. The available options are defined below.
CONTACT_PHONE_FDisplays the phone number masking applied to the contact’s phone number. See the View Phone Formats documentation for more information on the available masking options.
SORT_PHONEDisplays the number the system will use when sorting the contact’s phone number.
NO_AREA_CODE_SORTDisplays the number without the area code the system will use when sorting the contact’s phone number.
Modify own data options
OptionDescription
AAll. Contact is authorized to make changes to all account contacts.
NNone. Contact cannot update any contact information.
OOwn. Contact is authorized to make changes to their own profile only.
Contact type options
OptionDescription
01Fire authority contact.
02Police authority contact.
03Medic authority contact.
04Guard authority contact.
05Premises contact.
06Dealer contact.
07Subscriber contact.

SVACTIMG response fields

FieldDescription
ACCOUNT_NUMBERThe subscriber account number.
IMAGE_PATHDisplays the location of the image.
EXTENSIONDisplays the file type of the image.
DOC_TYPEDefines the image as being assigned to the subscriber.
DOC_NAMEDisplays the name given to the image.

Log Alarm

Log an existing pending alarm.

Supported attributes

AttrinbuteTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMMOMINI to log alarms.
OPTIONstringYesDetermines the method you will be using. Use LOG to log an alarm.
ACCOUNT_NUMBERstringYesDefines the subscriber account number the alarm is assgined to (9 character max).
DEALERstringYesDefines the account number of the deal that manages the subscriber (6 character max).
PRIORITYstringYesDefines the importance level assigned to the alarm (1 character max).
PASSCODE_VERIFIEDstringYesDefines if a passcode was verified for the alarm (1 character max).
PENDING_TIMEstringYesDefines the NTD time the alarm was delivered to pending.
INCIDENT_NUMBERstringYesDefines 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"
}

Possible error messages

Invalid method

Verify XMMOMINI is specified for the *setMethod attribute.

{
    "ERROR_CODE": "999",
    "ERROR_DESCRIPTION": "INVALID%20METHOD%20METHOD",
    "PROGRAM_ERROR": "11",
    "PROGRAM_ERROR_DESCRIPTION": "Missing%20or%20Duplicate%20key",
    "ERROR_ON_LINE": "240",
    "ADDITIONAL_INFO": "%3CMETHOD_NAME%3EXMAPEN%20%20%3C%2FMETHOD_NAME%3E"
}