Manage Account Information

This documentation will describe the Manage Account Information (XMHTTPSI) endpoint. This endpoint is responsible for creating and managing subscriber accounts within Matrix.

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

Use Cases

Data entering accounts.
Updating existing accounts.

Formatting

When submitting a POST request to add or update a subscriber, it is extremely important the request is properly formatted, and the included data is accurate. Improperly formatted requests can result in loss of data, incomplete data entry, or failure to update/add information. Follow the below guidelines to ensure your request is accurate and functional.

XML information tags

This endpoint accepts requests using XML information tags. This formatting differs from other endpoints that use curl formatted requests. See the below examples for guidance on how to format requests.

URL encoding

The POST must be URL encoded.

For example, %27 should be used in place of the ' character (Documentation%27s Test Account).

Overwrite warning

Depending on system setup flags, data submitted within the POST request will overwrite existing data not append it. This applies to Contacts, Zones, and Schedules.

This also applies to empty tags. If a tag under the Subscriber tag is blank when included, any existing subscriber data under that tag will be removed. Omitted tags will be unchanged.

Supported tags

Users will define account information using the available XML information tags. These tags are defined below and sorted by their location within Matrix Data Entry. All tags must be enclosed by the <subscriber> tag.

Required

The account and dealer tags must be included in each request.

Tag	Type	Description
account	string	The subscriber account number (`9` character max).
dealer	string	Defines the dealer account that manages the subscriber account (`6` character max).

Subscriber information

The following tags must be enclosed by the <subscriber> tag.

General

Tag	Type	Description
company_name	string	The primary company name or the name of the individual responsible for the account. (`28` character max).
street_no	string	The numerical part of the subscriber’s address (`8` character max).
street_name1	string	The street direction of the subscriber’s address (`2` character max).
street_name2	string	The name of the street of the subscriber’s address (`28` character max).
addtl_address	string	Additional address information such as P.O. box or apartment number (`28` character max).
city	string	The city name of the subscriber’s location (`18` characters max).
state	string	The state or province of the subscriber’s location (`3` character max).
zipcode	string	The postal code of the subscriber’s location (`10` character max).
country	string	The country abbreviation of the subscriber’s location (`3` character max).
district	string	The county name of the subscriber’s location (`12` character max).
xstreet	string	The road name of the street running perpendicular to the subscriber’s primary street location (`32` character max).
time_zone	string	Defines the time zone where the subscriber is located. Accepts: `EST`, `CST`, `MST`, `PST`, `ALS`, `AST`, `AZT`, or `HST`.
site_phone	string	Phone numbers that can be used to contact the subscriber (`16` character max per number). A maximum of six phone numbers can be entered using this tag.
misc_info_1	string	Defines additional information about the subscriber (`39` character max).
misc_info_2	string	Defines additional information about the subscriber (`39` character max).

Additional

Tag	Type	Description
active	string	Defines the status of the account. Accepts: `Y` or `N`. Note: If the account is set as active (`Y`), the `inactive_date` tag will be cleared. If the account is set as inactive (`N`), the `inactive_date` tag must be included.
active_reason	string	A brief description explaining why an account is being activated or inactivated (`40` character max).
start_date	string	Defines the date the subscriber became active in the system. Active is typically defined as beginning to send active signals. Expects `MMDDYY` format. Example: `120424`.
data_entered	string	The date the subscriber was data entered into the system. Expects `MMDDYY` format. Example: `120424`.
start_date_with_dealer	string	The date the subscriber became a client of their current dealer. Expects `MMDDYY` format. Example: `120424`.
inactive_date	string	Defines the date the subscriber became inactive in the system. Expects `MMDDYY` format. Example: `120624`.
panel_type	string	Defines the brand/model of the alarm panel used on the account (`10` character max). The selected panel type must exist in the system.
comm_res	string	Defines the property type of the subscriber. Accepts: `C`, `R`, `A`, or `X`. These options are defined below.
default_zone_list	string	The name of the dealer zone list that should be assigned to the subscriber (`6` character max).
two_way	string	Determines if the account will use DICE two way. Accepts: `Y` or `N`. Note: access to this tag must be granted by DICE. Contact DICE Support for more information.
supervise_schedule	string	Determines how signals are handled during supervised schedules. Accepts: `A`, `N`, `Y`, `I`, `U`, `F`, `V`, `O`, `C`, or `P`. These options are defined below. Note: access to this tag must be granted by DICE. Contact DICE Support for more information.
m_branch	string	Defines the ID of the monitoring branch that the subscriber should be assigned to (`3` character max).
map	string	Defines the code that identifies the map assigned to the subscriber (`6` character max).
passcode_needed	string	Determines if operators are required to use/verify passcodes when handling alarms on this account. Accepts: `Y` or `N`. Note: access to this tag must be granted by DICE. Contact DICE Support for more information.

Commercial/Residential options

Option	Definition
C	Commercial. A place of business.
R	Residential. A private residence/home.
A	Answering Service. A business that receives and answers phone calls for its clients.
X	Other. Property that doesn’t fall into the other categories.

Supervise schedule options

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

Handling

Tag	Type	Description
zone_wildcards	string	Determines if the account should use wildcards (`@`) when defining zones/signal codes. Accepts: `Y` or `N`. Note: access to this tag must be granted by DICE. Contact DICE Support for more information.
use_areas	string	Determines if the account should use areas. Accepts: `Y`, `N`, or `S`. These options are defined below. Note: access to this tag must be granted by DICE. Contact DICE Support for more information.
catch_late_tos	string	Determines if late-to alarms are system handled depending on how their required alarm is received. Accepts `Y` or `N`.
ee_delay	string	Determines if the account should use entry/exit delays when arming/disarming the system. Accepts: `Y` or `N`. Note: access to this tag must be granted by DICE. Contact DICE Support for more information.
generate_sig_on_test	string	Determines if the account will automatically send a `DISAB` signal when placed on test. Accepts: `Y` or `N`. Note: access to this tag must be granted by DICE. Contact DICE Support for more information.

Use area options

Option	Definition
Y	Yes. The account will use areas.
N	No. The account will not use areas.
S	Schedules. The account will use areas for schedules only.

Timers

Tag	Type	Description
any_signal_a_test	string	Determines which signals should be flagged as test signals when received from the account. Accepts: `Y`, `N`, or `Z`. These options are defined below.
test_span	string	Determines the amount of time expected to elapse between test signals. Accepts: `H`, `D`, `W`, `M`, `Q`, or `N`. These options are defined below.
hourly_test_span	string	Only applicable if `H` is defined for `test_span`. Determines the amount of time, in hours, the system expects to elapse between test signals (`3` character max). Users can granularly define time within this field. More information on formatting daily, weekly, and monthly time frames can be found below.
system_handle_hourly	string	Determines if hourly test signals will be system handled. Accepts: `Y` or `N`.

Any signal a test options

Option	Definition
Y	Yes. Any signal received on the account should be treated and handled as a test signal.
N	No. Only valid test signals received on the account should be treated and handled as test signals.
Z	Zone. Test signal handling will be determined zone-by-zone.

Test span options

Option	Definition
H	Hourly. Allows users to define the precise amount of time the system should expect to elapse between testing signals on the account.
D	Daily. Sets the test span to one full day (24 hours) between signals. All test signals using this span type will be system handled.
W	Weekly. Sets the test span to one full week (7 days) between signals. All test signals using this span type will be system handled.
M	Monthly. Sets the test span to one full month (28 days) between signals. All test signals using this span type will be system handled.
Q	Quarterly. Sets the test span to three full months (90 days) between test signals. All test signals using this span type will be system handled.
N	Never. Test signals are not expected on this account.

Hourly Test Span

The test_span tag allows users to determine the time increment for test signals. The available time formats are defined below.

Hours: To define the length of time in hours input the desired number of hours into the field.
For Example: 123 would be one hundred and twenty-three hours.
Days: to define a number of days, input the desired number of days followed by the D character into the field.
For Example: 12D would be twelve days.
Weeks: to define a number of weeks, input the desired number of weeks followed by the W character into the field.
For Example: 12W would be twelve weeks.
Months: to define a number of months, input the desired number of months followed by the M character.
For Example: 12M would be twelve months.

Identifiers

Tag	Type	Description
identifier	string	Used to populate the various custom identifier fields. Requires the `name` attribute. More information on formatting identifier tags can be found below.
identifier_4	string	Custom identifier used for miscellaneous information (`15` character max).

Formatting identifier tags

When specifying identifiers, the tag requires a name attribute.

Example request

--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}}' \
--form '*setMethod="XMHTTPSI"' \
--form 'data="<subscriber>
     <account>ACCT01</account>
     <dealer>DLR01</dealer>
     <identifier name="DLRACTNUM">1234567890123456</identifier>
     <identifier name="SIRENTYPE">MEDIUM</identifier>
</subscriber>"

Example response

{
    "update": {
        "status": "success",
        "account": "ACCT01"
    }
}

Accounting

Tag	Type	Description
b_branch	string	Defines the ID of the billing branch that the subscriber should be assigned to (`3` character max). Note: access to this tag must be granted by DICE. Contact DICE Support for more information.
s_branch	string	Defines the ID of the service branch that the subscriber should be assigned to (`3` character max). Note: access to this tag must be granted by DICE. Contact DICE Support for more information.
i_branch	string	Defines the ID of the installation branch that the subscriber should be assigned to (`3` character max). Note: access to this tag must be granted by DICE. Contact DICE Support for more information.
site_sales_tax_group	string	Defines the ID of the sales tax group the subscriber should be assigned to (`6` character max). Note: access to this tag must be granted by DICE. Contact DICE Support for more information.
site_salesrep_group	string	Defines the sales representative or group ID that sold the subscriber their services. The Sales Rep Group defines the sales department/group of individuals who closed the sale on the account (`6` character max). Note: access to this tag must be granted by DICE. Contact DICE Support for more information.
rate_table	string	Defines the ID of the dealer rate table the subscriber should be assigned to (`6` character max).
po_number	string	Custom identifier that will be assigned to any purchase orders created on the subscriber (`15` character max).

Notes

Tag	Type	Description
site_directions	string	Defines notes relating to special instructions technicians should follow when servicing the site (free form text).

Contacts

The following tags must be enclosed by the <contact> tag.

Tag	Type	Description
contact_name	string	The first and last name of a subscriber contact (`20` character max). This tag must be listed first when defining contact information.
contact_personal_info	string	Defines any miscellaneous information about the contact (`30` character max).
contact_phone	string	The contact’s primary phone number (`16` character max).
passcode	string	Defines the code the contact uses to verify their identity (`15` character max).
opening_id	string	Defines the code that will generate an opening signal on the subscriber (`3` character max).
closing_id	string	Defines the code that will generate a closing signal on the subscriber (`3` character max).
default_list_no	string	Defines the unique contact identifier assigned to an existing contact (`2` character max). When included, the existing contact will be updated with the defined information.

Authorized passcodes

If a contact entry is to be used for submitting a password or passcode, use AUTHORIZED PASSCODE for the contact_name tag.

Example request

--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}}' \
--form '*setMethod="XMHTTPSI"' \
--form 'data="<subscriber>
<account>ACCT01</account>
<dealer>DLR01</dealer>
<contact>
    <contact_name>AUTHORIZEDPASSCODE</contact_name>
    <passcode>123456</passcode>
</contact>
</subscriber>

Example response

{
    "update": {
        "status": "success",
        "account": "ACCT01"
    }
}

Authorities

The following tags are used to define authority contact information on the subscriber. The phone numbers entered for authorities must exist within the system. If an unknown number is used, the POST will be rejected.

Tag	Type	Description
do_psap_dip	string	Performs a PSAP dip using the submitted address information to data enter nearby authorities. Accepts: `Y` to use. Note: Using this option will incur costs. Contact DICE for more information on PSAP costs.
police	string	The phone number used to contact law enforcement for the subscriber (`16` character max).
fire	string	The phone number used to contact the fire department for the subscriber (`16` character max).
medical	string	The phone number used to contact emergency medical personnel for the subscriber (`16` character max).
guard	string	The phone number used to contact sentry personnel for the subscriber (`16` character max).

Zones

The following tags must be enclosed by the <zone> tag.

Tag	Type	Description
first_zone	string	Defines the numeric identifier of the first zone on the subscriber account (`9` character max). Do not include leading zeros. This tag must be listed first when defining zone information.
first_zone_code	string	Defines the event code of the first zone on the subscriber account (`3` character max). The event code used must match one of the existing codes within the system.
zone_desc	string	Defines a brief explanation of the zone (`30` character max).
additional_zone_desc	string	Defines additional information about the zone (`147` character max).

Scheduling

The following tags must be enclosed by the <schedule> tag.

Tag	Type	Description
sched_event_type	string	Determines the event type assigned to the subscriber’s schedules. Accepts: `B`, `C`, `O`, `S`, `U` or `W`. These options are defined below. Note: this will affect all schedules.
sched_day	string	Determines the day of the week the schedule applies to. Accepts: `1` (Sunday), `2` (Monday), `3` (Tuesday), `4` (Wednesday), `5` (Thursday), `6` (Friday), or `7` (Saturday).
sched_begin	string	Defines the time (24-hour format) the schedule will begin on the assigned day of the week. Expects `HHMM` format. Example: `1330`.
sched_end	string	Defines the time (24-hour format) the schedule will end on the assigned day of the week. Expects: `HHMM` format. Example: `1330`.
sched_freq	string	Defines the frequency in which open/close signals are valid during the schedule’s event window. Accepts: `O` or `M`. These options are defined below.
sched_area	string	Defines the code assigned to the area the schedule will be limited to (`3` character max).
sched_ltc	string	Determines if the system should generate a late to close (LTC) signal in the event the site did not generate a close signal at the appropriate time. Accepts: `Y` or `N`.
sched_lto	string	Determines if the system should generate a late to open (LTO) signal in the event the site did not generate an open signal at the appropriate time. Accepts: `Y` or `N`.
sched_opened_late	string	Determines if the system will label an open signal as `opened late` in the event the signal was received after the assigned late-to day and time. Accepts: `Y` or `N`.
sched_late_time	string	Defines the time (24-hour format) the system will generate a late-to signal for this schedule. Expects `HHMM` format. Example: `1330`.
sched_user_id	string	Defines the ID of the user the schedule will be limited to (`3` character max). If this tag is used, the event will be specific to the user ID sent from the panel.
early_open_window	string	Defines the time (24-hour format) open signals will be treated as early to open (ETO) signals. Expects `HHMM` format. Example: `1330`. Note: this will affect all schedules.
late_open_window	string	Defines the time (24 hour format) open signals will be treated as LTO signals. Expects `HHMM` format. Example: `1330`. Note: this will affect all schedules.
early_close_window	string	Defines the time (24-hour format) close signals will be treated as early to close (ETC) signals. Expects `HHMM` format. Example: `1330`. Note: this will affect all schedules.
late_close_window	string	Defines the time (24-hour format) close signals will be treated as LTC signals. Expects `HHMM` format. Example: `1330`. Note: this will affect all schedules.

Schedule event type options

Option	Definition
B	Both. Both open and close signals will be system handled during the assigned time frame.
C	Close. Close signals will be system handled during the assigned time frame.
O	Open. Open signals will be system handled during the assigned time frame.
S	Supervised. Open and close signals will be operator handled during the assigned time frame.
U	Unsupervised. Open and close signals will be system handled during the assigned time frame.
W	Welfare. The system will generate a late to welfare (LTW) signal at the appropriate time.

Schedule frequency options

Option	Definition
O	One. The site is limited to only one opening and closing signal.
M	Many. The site isn’t limited.

Example request

--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}}' \
--form '*setMethod="XMHTTPSI"' \
--form 'data="<subscriber>
     <account>ACCT01</account>
     <company_name>User Test Subscriber</company_name>
     <street_no>1234</street_no>
     <street_name1>N</street_name1>
     <street_name2>Willow Ave</street_name2>
     <addtl_address>Unit 122</addtl_address>
     <city>Essexville</city>
     <state>MI</state>
     <zipcode>48732</zipcode>
     <country>USA</country>
     <xstreet>HAMPTONRD</xstreet>
     <time_zone>EST</time_zone>
     <comm_res>R</comm_res>
     <site_phone>555-234-2342</site_phone>
     <po_number>123</po_number>
     <district>BAY</district>
     <date_entered>123107</date_entered>
     <start_date_with_dealer>040722</start_date_with_dealer>
     <test_span>H</test_span>
     <hourly_test_span>25</hourly_test_span>
     <system_handle_hourly>N</system_handle_hourly>
     <any_signal_a_test>N</any_signal_a_test>
     <panel_type>2200</panel_type>
     <default_zone_list>0075</default_zone_list>
     <identifier_4>TEST4</identifier_4>
     <misc_info_1>TEST MISC INFO 1</misc_info_1>
     <misc_info_2>TEST MISC INFO2</misc_info_2>
     <dealer>DLR01</dealer>
     <map>book1</map>
     <site_directions>These are the site directions for the subscriber</site_directions>
     <identifier name="SIRENTYPE">MEDIUM</identifier>
     <active>N</active>
     <inactive_date>123124</inactive_date>
     <do_psap_dip>Y</do_psap_dip>
     <contact>
          <contact_name>JOHNDOE</contact_name>
          <contact_personal_info>CELLPHONE </contact_personal_info>
          <contact_phone>555-234-1231</contact_phone>
          <passcode>3321</passcode>
          <opening_id>001</opening_id>
          <closing_id>002</closing_id>
          <default_list_no>10</default_list_no>
     </contact>
     <contact>
         <contact_name>ADAMEURICH</contact_name>
         <contact_personal_info>WORKPHONE </contact_personal_info>
         <contact_phone>555-223-3424</contact_phone>
         <passcode>54443</passcode>
     </contact>
     <zone>
         <first_zone>100</first_zone>
         <first_zone_code>001</first_zone_code>
         <zone_desc>SMOKEALARM</zone_desc>
         <additional_zone_desc>UPSTAIRSBEDROOM </additional_zone_desc>
     </zone>
     <zone>
         <first_zone>200</first_zone>
         <first_zone_code>003</first_zone_code>
         <zone_desc>BURGLARY</zone_desc>
         <additional_zone_desc>MASTER BEDROOM</additional_zone_desc>
    </zone>
    <police>5553432342</police>
    <fire>5553423423</fire>
    <early_open_window>5</early_open_window>
    <late_open_window>5</late_open_window>
    <early_close_window>5</early_close_window>
    <late_close_window>5</late_close_window>
    <schedule>
         <sched_event_type>O</sched_event_type>
         <sched_day>2</sched_day>
         <sched_begin>0800</sched_begin>
         <sched_end>1700</sched_end>
         <sched_freq>M</sched_freq>
         <sched_area>1</sched_area>
         <sched_ltc>N</sched_ltc>
         <sched_lto>Y</sched_lto>
         <sched_opened_late>Y</sched_opened_late>
         <sched_late_time>0830</sched_late_time>
         <sched_user_id>001</sched_user_id>
     </schedule>
     <schedule>
         <sched_event_type>C</sched_event_type>
         <sched_day>2</sched_day>
         <sched_begin>0800</sched_begin>
         <sched_end>1700</sched_end>
         <sched_freq>M</sched_freq>
         <sched_area>1</sched_area>
         <sched_ltc>Y</sched_ltc>
         <sched_lto>N</sched_lto>
         <sched_late_time>1700</sched_late_time>
         <sched_user_id>001</sched_user_id>
     </schedule>
     <schedule>
         <sched_event_type>B</sched_event_type>
         <sched_day>3</sched_day>
         <sched_begin>0800</sched_begin>
         <sched_end>1700</sched_end>
         <sched_freq>M</sched_freq>
         <sched_area>1</sched_area>
         <sched_ltc>Y</sched_ltc>
         <sched_lto>Y</sched_lto>
         <sched_late_time>0830</sched_late_time>
         <sched_user_id>001</sched_user_id>
     </schedule>
 </subscriber>"

Example response

If the authentication and included tags are valid, a success code will be returned.

{
    "update": {
        "status": "success",
        "account": "ACCT01"
    }
}

Delete subscriber

The action tag is used to delete a subscriber account from the system. The only acceptable value for this tag is delete.

Example request

--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}}' \
--form '*setMethod="XMHTTPSI"' \
--form 'data="<subscriber>
        <account>ACCT01</account>
        <dealer>DLR01</dealer>
        <action>delete</action>
    </subscriber>"

Example response

 {
    "update": {
        "status": "success",
        "account": "ACCT01"
    }
}

Possible error messages

The possible error messages users may encounter, and how to resolve are defined below. The subscriber information errors are organized by the tab they appear in within Data Entry

General

Blank account number

Verify the account tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "001",
        "errordesc": "BLANK ACCOUNT NUMBER"
    }
}

Invalid dealer

Verify the dealer tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "006",
        "errordesc": "INVALID DEALER"
    }
}

Different dealer

Verify the dealer tag is populated with the correct dealer account assigned to the subscriber.

{
    "update": {
        "status": "failed",
        "errorcode": "007",
        "errordesc": "DIFFERENT DEALER THAN WHAT IS ON THE ACCOUNT"
    }
}

Account not assigned

Verify the selected account is a valid and is assigned to the selected dealer account.

{
    "update": {
        "status": "failed",
        "errorcode": "016",
        "errordesc": "ACCOUNT IS NOT ASSIGNED TO YOU "
    }
}

Invalid time zone

Verify the time_zone tag is populated with a valid value (EST, CST, MST, PST, ALS, AST, AZT, or HST).

{
    "update": {
        "status": "failed",
        "errorcode": "044",
        "errordesc": "INVALID TIME ZONE."
    }
}

Account does not exist

Verify the account tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "055",
        "errordesc": "ACCOUNT DOES NOT EXIST.  CANNOT SET ACTIVE STATUS."
    }
}

Additional

Invalid panel type

Verify the panel_type tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "002",
        "errordesc": "INVALID PANEL TYPE"
    }
}

Invalid default zone list

Verify the default_zone_list tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "003",
        "errordesc": "INVALID DEFAULT ZONE LIST"
    }
}

Invalid start date with dealer

Verify the start_date_with_dealer tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "020",
        "errordesc": "INVALID START DATE WITH DEALER"
    }
}

Invalid property type

Verify the comm_res tag is populated with a valid value (C, R, X, or A).

{
    "update": {
        "status": "failed",
        "errorcode": "045",
        "errordesc": "INVALID COMMERCIAL-RESIDENTIAL VALUE"
    }
}

Invalid active tag

Verify the active tag is populated with a valid value (Y or N).

{
    "update": {
        "status": "failed",
        "errorcode": "048",
        "errordesc": "INVALID ACTIVE VALUE"
    }
}

Invalid inactive date

Verify the inactive_date tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "049",
        "errordesc": "INVALID INACTIVE DATE"
    }
}

Invalid two way

Verify the two_way tag is populated with a valid value (Y or N).

{
    "update": {
        "status": "failed",
        "errorcode": "064",
        "errordesc": "INVALID VALUE FOR TWO WAY (Y,N)"
    }
}

Invalid passcode needed

Verify the passcode_needed tag is populated with a valid value (Y or N).

{
    "update": {
        "status": "failed",
        "errorcode": "066",
        "errordesc": "INVALID VALUE FOR PASSCODE NEEDED (Y,N)"
    }
}

Invalid monitoring branch

Verify the m_branch tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "072",
        "errordesc": "INVALID VALUE FOR M BRANCH"
    }
}

Handling

Invalid zone wildcards

Verify the zone_wildcards tag is populated with a valid value (Y or N).

{
    "update": {
        "status": "failed",
        "errorcode": "061",
        "errordesc": "INVALID VALUE FOR ZONE WILDCARDS (Y,N)"
    }
}

Invalid use areas

Verify the use_areas tag is populated with a valid value (Y, N, or S).

{
    "update": {
        "status": "failed",
        "errorcode": "063",
        "errordesc": "INVALID VALUE FOR USE AREA (Y,N,S)"
    }
}

Invalid supervise schedule

Verify the supervise_schedule tag is populated with a valid value (A, N, Y, I, U, F, V, O, C, or P).

{
    "update": {
        "status": "failed",
        "errorcode": "065",
        "errordesc": "INVALID VALUE FOR SUPERVISE SCHEDULE (A,N,Y,I,U,F,V,O,C,P)"
    }
}

Invalid EE delay

Verify the ee_delay tag is populated with a valid value (Y or N).

{
    "update": {
        "status": "failed",
        "errorcode": "067",
        "errordesc": "INVALID VALUE FOR EE DELAY (Y,N)"
    }
}

Invalid catch late-tos

Verify the catch_late_tos tag is populated with a valid value (Y or N).

{
    "update": {
        "status": "failed",
        "errorcode": "076",
        "errordesc": "INVALID VALUE FOR CATCH LATE TOS (Y,N)"
    }
}

Invalid generate signal on test

Verify the generate_sig_on_test tag is populated with a valid value (Y or N).

{
    "update": {
        "status": "failed",
        "errorcode": "080",
        "errordesc": "INVALID GENERATE SIGNAL ON TEST"
    }
}

Timers

Invalid value for any signal a test

Verify the any_signal_a_test tag is populated with a valid value (Y, N, or Z).

{
    "update": {
        "status": "failed",
        "errorcode": "017",
        "errordesc": "INVALID VALUE FOR ANY SIGNAL A TEST (Y,N,Z)"
    }
}

Invalid test span

Verify the test_span tag is populated with a valid value ( H, D, W, M, Q, or N).

{
    "update": {
        "status": "failed",
        "errorcode": "021",
        "errordesc": "INVALID TEST SPAN.  (H,D,W,M,Q,N)"
    }
}

Invalid hourly test value

Verify the hourly_test_span tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "022",
        "errordesc": "INVALID HOURLY TEST VALUE.  (.01-999, MODIFIERS D,M,W)"
    }
}

Invalid system handle value

Verify the system_handle_hourly tag is populated with a valid value (Y or ``N`).

{
    "update": {
        "status": "failed",
        "errorcode": "023",
        "errordesc": "INVALID HOURLY SYSTEM HANDLE VALUE.  (Y/N)"
    }
}

Invalid test span values

Verify the test_span and system_handle_hourly tags are populated with valid corresponding values.

{
    "update": {
        "status": "failed",
        "errorcode": "024",
        "errordesc": "INVALID SYSTEM HANDLE VALUE NOT VALID WITH TEST SPAN VALUE"
    }
}

Invalid test span combination

Verify the test span tags (test_span and hourly_test_span) are populated with valid corresponding values.

{
    "update": {
        "status": "failed",
        "errorcode": "025",
        "errordesc": "INVALID HOURLY TEST VALUE/TEST SPAN COMBINATION"
    }
}

Identifiers

Invalid identifier format

Verify any included identifier tags are formatted as in the Identifier tags section.

{
    "update": {
        "status": "failed",
        "errorcode": "050",
        "errordesc": "INVALID IDENTIFIER FORMAT - "
    }
}

Invalid identifier

Verify the included identifier tags are populated with existing identifier IDs.

{
    "update": {
        "status": "failed",
        "errorcode": "051",
        "errordesc": "INVALID IDENTIFIER - IDENTNUMUUID"
    }
}

Invalid identifier data

Verify the included identifier tags are populated with valid information and formatted properly.

{
    "update": {
        "status": "failed",
        "errorcode": "052",
        "errordesc": "INVALID IDENTIFIER DATA - "
    }
}

Identifier must be unique

Verify the included applicable identifier tags are populated with unique information.

{
    "update": {
        "status": "failed",
        "errorcode": "053",
        "errordesc": "IDENTIFIER MUST BE UNIQUE - "
    }
}

Identifier is too long

Verify the included identifier tags follow character limits.

{
    "update": {
        "status": "failed",
        "errorcode": "054",
        "errordesc": "IDENTIFIER IS TOO LONG -"
    }
}

Accounting

Invalid service code

Verify the s_branch tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "004",
        "errordesc": "INVALID SERVICE CODE"
    }
}

Invalid site sales tax group

Verify the site_sales_tax_group tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "068",
        "errordesc":  "INVALID VALUE FOR SITE SALES TAX GROUP"
    }
}

Invalid billing branch

Verify the b_branch tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "069",
        "errordesc":  "INVALID VALUE FOR B BRANCH"
    }
}

Invalid service branch

Verify the s_branch tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "070",
        "errordesc":  "INVALID VALUE FOR S BRANCH"
    }
}

Invalid installation branch

Verify the i_branch tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "071",
        "errordesc":  "INVALID VALUE FOR I BRANCH"
    }
}

Invalid site sales rep group

Verify the site_salesrep_group tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "075",
        "errordesc":  "INVALID VALUE FOR SITE SALESREP GROUP"
    }
}

Invalid rate table

Verify the rate_table tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "077",
        "errordesc":  "INVALID VALUE FOR RATE TABLE"
    }
}

Contacts

Duplicate opening ID

Update the sent contact information to ensure each contact has a unique opening ID assigned.

{
    "update": {
        "status": "failed",
        "errorcode": "026",
        "errordesc": "OPENING-ID "001" IS DUPLICATED"
    }
}

Duplicate closing ID

Update the sent contact information to ensure each contact has a unique closing ID assigned.

{
    "update": {
        "status": "failed",
        "errorcode": "027",
        "errordesc": "CLOSING-ID "002" IS DUPLICATED"
    }
}

Authorities

Fire code not found

Verify the fire tag is populated with an existing fire department phone number.

{
    "update": {
        "status": "failed",
        "errorcode": "011",
        "errordesc": "FIRE CODE NOT FOUND FOR 55553436789"
    }
}

Police code not found

Verify the police tag is populated with an existing police phone number.

{
    "update": {
        "status": "failed",
        "errorcode": "012",
        "errordesc": "POLICE CODE NOT FOUND FOR 55553436789"
    }
}

Medical code not found

Verify the medical tag is populated with an existing medic phone number.

{
    "update": {
        "status": "failed",
        "errorcode": "013",
        "errordesc": "MEDICAL CODE NOT FOUND FOR 55553436789"
    }
}

Guard code not found

Verify the guard tag is populated with an existing guard services phone number.

{
    "update": {
        "status": "failed",
        "errorcode": "014",
        "errordesc": "GUARD CODE NOT FOUND FOR 55553436789"
    }
}

Zones

Blank zone sent

Verify the first_zone tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "008",
        "errordesc": "BLANK ZONE SENT"
    }
}

Zone code does not exist

Verify the first_zone tag is populated with an existing zone code.

{
    "update": {
        "status": "failed",
        "errorcode": "009",
        "errordesc": "FIRST ZONE CODE DOES NOT EXIST"
    }
}

Schedules

Invalid schedule event type

Verify the sched_event_type tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "028",
        "errordesc": "BAD SCHEDULE EVENT TYPE "P".  O,C,B,S,U ARE VALID"
    }
}

Invalid schedule day

Verify the sched_day tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "029",
        "errordesc": "BAD SCHEDULE DAY "9".  1-7 ARE VALID.  1=SUNDAY, 2=MONDAY, 3=TUESDAY..."
    }
}

Invalid schedule begin time

Verify the sched_begin tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "030",
        "errordesc": "BAD SCHEDULE BEGIN "2600".  0000-2359 IS VALID"
    }
}

Invalid schedule end time

Verify the sched_end tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "031",
        "errordesc": "BAD SCHEDULE END "2600".  0000-2359 IS VALID"
    }
}

Invalid schedule frequency

Verify the sched_freq tag is populated with a valid value (O or M).

{
    "update": {
        "status": "failed",
        "errorcode": "032",
        "errordesc": "BAD SCHEDULE FREQUENCY "L".  O, M ARE VALID.  O=ONCE, M=MANY"
    }
}

Invalid schedule area

Verify the sched_area tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "033",
        "errordesc": "BAD SCHEDULE AREA LENGTH "1234".  AREA CAN BE UP TO THREE CHARACTERS LONG"
    }
}

Invalid schedule LTC

Verify the sced_ltc tag is populated with a valid value (Y or N).

{
    "update": {
        "status": "failed",
        "errorcode": "034",
        "errordesc": "BAD SCHEDULE LTC "C".  Y,N ARE VALID."
    }
}

Invalid schedule LTO

Verify the sched_lto tag is populated with a valid value (Y or N).

{
    "update": {
        "status": "failed",
        "errorcode": "035",
        "errordesc": "BAD SCHEDULE LTO "Z".  Y,N ARE VALID."
    }
}

Invalid schedule opened late

Verify the sched_opened_late tag is populated with a valid value (Y or N).

{
    "update": {
        "status": "failed",
        "errorcode": "036",
        "errordesc": "BAD SCHEDULE OPENED LATE "D".  Y,N ARE VALID"
    }
}

Invalid schedule late time

Verify the sched_late_time tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "037",
        "errordesc": "BAD SCHEDULE LATE TIME "2700".  0000-2359 IS VALID"
    }
}

Missing late time

Verify the sched_late_time tag is included and populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "038",
        "errordesc": "SCHED_LTO IS Y, THEREFOR A LATE TIME IS REQUIRED"
    }
}

Invalid user ID

Verify the sched_user_id tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "039",
        "errordesc": "BAD USER LENGTH "0013".  USERS CAN BE UP TO THREE CHARACTERS LONG"
    }
}

Invalid early open window

Verify the early_open_window tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "040",
        "errordesc": "BAD EARLY OPEN WINDOW "9999".  0-999 IS VALID"
    }
}

Invalid late open window

Verify the late_open_window tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "041",
        "errordesc": "BAD LATE OPEN WINDOW "99".  0-999 IS VALID"
    }
}

Invalid early close window

Verify the early_close_window tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "042",
        "errordesc": "BAD EARLY CLOSE WINDOW "99".  0-999 IS VALID"
    }
}

Invalid late close window

Verify the late_close_window tag is populated with a valid value.

{
    "update": {
        "status": "failed",
        "errorcode": "043",
        "errordesc": "BAD LATE CLOSE WINDOW "99".  0-999 IS VALID"
    }
}

Miscellaneous

Sender not allowed

Verify the specified dealer account is data entered within the Valid HTTP XML post IP addresses menu option within CORE. The dealer account must be added with the Subscr Post option set to Y and the IP Address set to ALL.

{
    "STATUS": "ERROR",
    "MESSAGE": "SENDER NOT ALLOWED"
}

Account is being edited

The subscriber account you are attempting to update is currently locked by another user. Unlock the account and try again.

{
    "update": {
        "status": "failed",
        "errorcode": "056",
        "errordesc": "ACCOUNT IS BEING EDITED BY ANOTHER USER AT THIS TIME"
    }
}

Don’t have access to update

Contact your central station administrator. Your user likely is not set up properly to update account information.

{
    "update": {
        "status": "failed",
        "errorcode": "999",
        "errordesc": "YOU DO NOT HAVE ACCESS TO UPDATE"
    }
}

Manage Account Information

Use Cases #

Formatting #

XML information tags #

URL encoding #

Overwrite warning #

Supported tags #

Required #

Subscriber information #

General #

Additional #

Commercial/Residential options #

Supervise schedule options #

Handling #

Use area options #

Timers #

Any signal a test options #

Test span options #

Hourly Test Span #

Identifiers #

Formatting identifier tags #

Example request #

Example response #

Accounting #

Notes #

Contacts #

Authorized passcodes #

Example request #

Example response #

Authorities #

Zones #

Scheduling #

Schedule event type options #

Schedule frequency options #

Example request #

Example response #

Delete subscriber #

Example request #

Example response #

Possible error messages #

General #

Blank account number #

Invalid dealer #

Different dealer #

Account not assigned #

Invalid time zone #

Account does not exist #

Additional #

Invalid panel type #

Invalid default zone list #

Invalid start date with dealer #

Invalid property type #

Invalid active tag #

Invalid inactive date #

Invalid two way #

Invalid passcode needed #

Invalid monitoring branch #

Handling #

Invalid zone wildcards #

Invalid use areas #

Invalid supervise schedule #

Invalid EE delay #

Invalid catch late-tos #

Invalid generate signal on test #

Timers #

Invalid value for any signal a test #

Invalid test span #

Invalid hourly test value #

Invalid system handle value #

Invalid test span values #

Invalid test span combination #

Identifiers #

Invalid identifier format #

Invalid identifier #

Invalid identifier data #

Identifier must be unique #

Identifier is too long #

Accounting #

Invalid service code #

Invalid site sales tax group #

Use Cases

Formatting

XML information tags

URL encoding

Overwrite warning

Supported tags

Required

Subscriber information

General

Additional

Commercial/Residential options

Supervise schedule options

Handling

Use area options

Timers

Any signal a test options

Test span options

Hourly Test Span

Identifiers

Formatting identifier tags

Example request

Example response

Accounting

Notes

Contacts

Authorized passcodes

Example request

Example response

Authorities

Zones

Scheduling

Schedule event type options

Schedule frequency options

Example request

Example response

Delete subscriber

Example request

Example response

Possible error messages

General

Blank account number

Invalid dealer

Different dealer

Account not assigned

Invalid time zone

Account does not exist

Additional

Invalid panel type

Invalid default zone list

Invalid start date with dealer

Invalid property type

Invalid active tag

Invalid inactive date

Invalid two way

Invalid passcode needed

Invalid monitoring branch

Handling

Invalid zone wildcards

Invalid use areas

Invalid supervise schedule

Invalid EE delay

Invalid catch late-tos

Invalid generate signal on test

Timers

Invalid value for any signal a test

Invalid test span

Invalid hourly test value

Invalid system handle value

Invalid test span values

Invalid test span combination

Identifiers

Invalid identifier format

Invalid identifier

Invalid identifier data

Identifier must be unique

Identifier is too long

Accounting

Invalid service code

Invalid site sales tax group

Invalid billing branch