Manage Account Disables

This documentation will describe the Manage Account Disables (XMDISUTL) endpoint. This endpoint is responsible for managing tests assigned to subscribers within On/Off Test.

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

Use cases

Test account signalling
Test account zones
Modify existing disables

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.

Add disable

Assign a time frame to the account that determines how long the account will be disabled for.

Supported attributes

Attribute	Type	Required	Description
*setMethod	string	Yes	Determines the endpoint you are calling. Must be `XMDISUTL` to manage disables.
OPTION	string	Yes	Determines the method you will be using. Use `DISABLE` when adding disables.
ACCOUNT_NUMBER	string	Yes	The subscriber account number (`9` character max). The system will apply the disable to this account.
ADD_REASON	string	Yes	Determines the message written to history when a disable is added to the account (`30` character max).
DISINFO	string	No	Determines the Info text assigned to the disable (`40` character max). Typically describes the reason the account was disabled.
DISABLE_ZONES	string	No	Determines the list of zones that will be disabled on the account (`60` character max). Expects zone numbers in a comma separated list. Defaults to `ALL` if left blank. Note: This attribute cannot be used in conjunction with the `DISABLE_TYPES` attribute.
DISABLE_TYPES	string	No	Determines the alarm types that will be disabled on the account (`255` character max). Expects alarm types in a comma separated list. Defaults to `ALL` if left blank. Note: This attribute cannot be used in conjunction with the `DISABLE_ZONES` attribute.
EXCEPT_THIS_ZONE	string	No	Determines which zones/types are disabled. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: all zones/types other than those defined in the `DISABLE_ZONES`/`DISABLE_TYPES` attributes will be disabled. `N`: only the zones listed in the `DISABLE_ZONES`/`DISABLE_TYPES` attributes will be disabled.
DIS_OR_RUN	string	No	Determines if the disable should be labeled as a runaway signal. Accepts `D` or `R`. Defaults to `D` if left blank. `D`: labels the record as a `disable`. `R`: labels the record as a `runaway`. Users must be granted permission to label records as runaway.
TIME_INCLUSIVE	string	No	Determines if the testing times will be limited to each day or for the full time span specified. Accepts `Y` or `N`. Defaults to `Y` if left blank. `Y`: the account will be disabled across the entire span of time selected from the Begin Date to the End Date. `N`: the account will be disabled during the selected Begin Time and End Time each selected day.
DISABLE_BEGIN_DATE	string	No	Determines the date the disable will start on the account (`6` character max). Expects `YYMMDD` format. Defaults to today’s date if left blank.
DISABLE_BEGIN_TIME	string	No	Determines the time the disable will start on the account (`4` character max). Expects `HHMI` (24-hour) format. The time frame defaults to the user’s assigned Default Test Time if left blank.
DISABLE_END_DATE	string	No	Determines the date the disable will expire on the account (`6` character max). Expects `YYMMDD` format. Defaults to today’s date if left blank.
DISABLE_END_TIME	string	No	Determines the time the disable will expire on the account (`4` character max). Expects `HHMI` (24-hour) format. The time frame defaults to the user’s assigned Default Test Time if left blank.
VALID_DAYS	string	Yes	Determines the days of the week the disable will be valid (`7` character max). Include a `Y` or `N` to define which days the disable should apply to. The order the days are expected in is: Sun, Mon, Tue, Wed, Thu, Fri, Sat. Will default to `Y` for all days if left blank. For example: a disable valid only during weekdays would use `NYYYYYN`.
DISABLE_LINKS	string	No	Determines if linked accounts will also be disabled. Accepts `Y` or `N`. Defaults to `N`. `Y`: linked accounts will be disabled. `N`: linked accounts will not be disabled.
PASSING_PARTITION	string	No	Determines if account partitions will be identified on the account. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: partitions will be identified. `N`: partitions will not be identified.
DISABLE_PARTITIONS	string	No	Determines if account partitions will also be disabled. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: partitions will be disabled. `N`: partitions will not be disabled.
DISABLE_GROUPS	string	No	Determines if the assigned account group will also be disabled. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: the group will also be disabled. `N`: the group will not be disabled.
DISABLE_ADDRESSES	string	No	Determines if accounts with the same address as the identified account will also be disabled. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: accounts with matching addresses will also be disabled. `N`: accounts with matching addresses will not be disabled.
CLEAR_ALARMS	string	No	Determines if pending alarms on the account are cleared once the account is placed on test. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: any pending alarms on the account will be system handled. `N`: any pending alarms on the account will remain in pending to be handled by an appropriate operator.
LIVE_NOTIFY	string	No	Determines if select individuals are notified when the account is disabled. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: applicable contacts will be notified when the disable takes effect. `N`: contacts will not be notified about disables.
LIVE_NOTIFY_ADDRESS	string	No	Determines the phone numbers or email addresses that will be notified (`60` character max). `LIVE_NOTIFY` must be set to `Y` to identify numbers/emails. Expects 10-digit phone numbers and emails in a comma delimited list.
LIVE_NOTIFY_FMT	string	No	Determines the information included in the notification (`128` character max). `%a%`: Account Number `%st%`: Event time in `HH:MM` format `%cc%`: SEIA Code if applicable `%z1%`: Zone Code 1 `%z2%`: Zone Code 2 `%ar%`: Area if applicable `%ht%`: History message `%zm%`: Message 2 Default Message: `%a% %st% - (%cc%) %z1% %z2% %ar% %ht% %zm%` Example text: `00TEST 03:26 - (BG) 12993 Burglary Status`
CHG_REASON	string	No	Determines the message written to history when a disable is updated (`30` character max).
MINUTES	integer	No	Determines the number of minutes the account will be disabled for (`4` character max).
LOG_MESSAGE	string	No	Defines message text that will be saved to the account’s history report (`30` 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="XMDISUTL"' \
--form 'OPTION="DISABLE"' \
--form 'ACCOUNT_NUMBER="KMN10"' \
--form 'DISINFO="Testing XMDISUTL"' \
--form 'DISABLE_ZONES=""' \
--form 'DISABLE_TYPES=""' \
--form 'EXCEPT_THIS_ZONE="Y"' \
--form 'DISABLE_RUNAWAY="D"' \
--form 'TIME_INCLUSIVE="N"' \
--form 'DISABLE_BEGIN_DATE="040225"' \
--form 'DISABLE_BEGIN_TIME="0900"' \
--form 'DISABLE_END_DATE="040225"' \
--form 'DISABLE_END_TIME="1400"' \
--form 'VALID_DAYS="NYYYYYN"' \
--form 'DISABLE_LINKS="N"' \
--form 'PASSING_PARTITION="N"' \
--form 'DISABLE_PARTITIONS="N"' \
--form 'DISABLE_GROUPS="N"' \
--form 'DISABLE_ADDRESSES="N"' \
--form 'CLEAR_ALARMS="Y"' \
--form 'LIVE_NOTIFY="N"' \
--form 'LIVE_NOTIFY_ADDRESS=""' \
--form 'LIVE_NOTIFY_FMT=""' \
--form 'ADD_REASON="Add reason text"' \
--form 'CHG_REASON="Change reason text"' \
--form 'MINUTES=""' \
--form 'LOG_MESSAGE="Log message text"'

Example response

{
    "A": "B",
    "ALDISCHD": {
        "COMPANY_NAME": "API TESTING",
        "STREET_NO": "1234",
        "STREET_NAME1": "N",
        "STREET_NAME2": "JONESRD.",
        "ADDTL_ADDRESS": "SUITE15",
        "CITY": "ESSEXVILLE",
        "STATE": "MI",
        "COUNTRY": "USA",
        "ZIPCODE": "48732",
        "ACCOUNT_NUMBER": "KMN10",
        "UNIQUE_KEY": "!",
        "FIRST_ZONE": "ALL",
        "BEGIN_DATE": "250130",
        "BEGIN_TIME": "0900",
        "END_DATE": "250130",
        "END_TIME": "1400",
        "INFORMATION": "TESTING XMDISUTL",
        "VALID_SUNDAY": "N",
        "VALID_MONDAY": "Y",
        "VALID_TUESDAY": "Y",
        "VALID_WEDNESDAY": "Y",
        "VALID_THURSDAY": "Y",
        "VALID_FRIDAY": "Y",
        "VALID_SATURDAY": "N",
        "NTD_BEGIN_DATE": "739283.37500",
        "NTD_END_DATE": "739283.58402",
        "DEALER": "KATE01",
        "EXCEPT_THIS_ZONE": "Y",
        "TIME_INCLUSIVE": "N",
        "MATCH_FIELD": "vU",
        "NTD_ON_TEST": "999999.99999",
        "NTD_OFF_TEST": "739283.58402",
        "NTD_LAST_ON_TEST": "739283.65809",
        "OPR": "KK",
        "NTD_ACCT_TZ_OFFSET": "0"
    },
    "ACCOUNT_TIME": {
        "SERVER_DATE": "01/30/2025 15:47:39",
        "ACCOUNT_DATE": "01/30/2025 15:47:39",
        "ACCOUNT_TIME_ZONE": "EST",
        "TZ_FACTOR": "0"
    }
}

Edit disable

Update existing disable entries on the subscriber account.

Overwrite warning

Data submitted within the edit request will overwrite existing data not append it. Blank attributes will use their system defaults.

Supported attributes

Attribute	Type	Required	Description
*setMethod	string	Yes	Determines the endpoint you are calling. Must be `XMDISUTL` to manage disables.
OPTION	string	Yes	Determines the method you will be using. Use `DISABLE` when adding disables.
ACCOUNT_NUMBER	string	Yes	The subscriber account number (`9` character max).
ADD_REASON	string	Yes	Determines the message written to history when a disable is added to the account (`30` character max).
UNIQUE_KEY	string	Yes	Determines the unique ID of the disable being edited (`5` character max).
DISINFO	string	No	Determines the Info text assigned to the disable (`40` character max). Typically describes the reason the account was disabled.
DISABLE_ZONES	string	Yes	Determines the list of zones that will be disabled on the account (`60` character max). Expects zone numbers in a comma separated list. Note: This attribute cannot be used in conjunction with the `DISABLE_TYPES` attribute.
DISABLE_TYPES	string	Yes	Determines the alarm types that will be disabled on the account (`255` character max). Expects alarm types in a comma separated list. Note: This attribute cannot be used in conjunction with the `DISABLE_ZONES` attribute.
EXCEPT_THIS_ZONE	string	No	Determines which zones/types are disabled. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: all zones/types other than those defined in the `DISABLE_ZONES`/`DISABLE_TYPES` attributes will be disabled. `N`: only the zones listed in the `DISABLE_ZONES`/`DISABLE_TYPES` attributes will be disabled.
DIS_OR_RUN	string	No	Determines if the disable should be labeled as a runaway signal. Accepts `D` or `R`. Defaults to `D` if left blank. `D`: labels the record as a `disable`. `R`: labels the record as a `runaway`. Users must be granted permission to label records as runaway.
TIME_INCLUSIVE	string	No	Determines if the testing times will be limited to each day or for the full time span specified. Accepts `Y` or `N`. Defaults to `Y` if left blank. `Y`: the account will be disabled across the entire span of time selected from the Begin Date to the End Date. `N`: the account will be disabled during the selected Begin Time and End Time each selected day.
DISABLE_BEGIN_DATE	string	No	Determines the date the disable will start on the account (`6` character max). Expects `YYMMDD` format. Defaults to today’s date if left blank.
DISABLE_BEGIN_TIME	string	No	Determines the time the disable will start on the account (`4` character max). Expects `HHMI` (24-hour) format. The time frame defaults to the user’s assigned Default Test Time if left blank.
DISABLE_END_DATE	string	No	Determines the date the disable will expire on the account (`6` character max). Expects `YYMMDD` format. Defaults to today’s date if left blank.
DISABLE_END_TIME	string	No	Determines the time the disable will expire on the account (`4` character max). Expects `HHMI` (24-hour) format. The time frame defaults to the user’s assigned Default Test Time if left blank.
VALID_DAYS	string	Yes	Determines the days of the week the disable will be valid (`7` character max). Include a `Y` or `N` to define which days the disable should apply to. The order the days are expected in is: Sun, Mon, Tue, Wed, Thu, Fri, Sat. Will default to `Y` for all days if left blank. For example: a disable only valid during weekdays would use `NYYYYYN`.
DISABLE_LINKS	string	No	Determines if linked accounts will also be disabled. Accepts `Y` or `N`. Defaults to `N`. `Y`: linked accounts will be disabled. `N`: linked accounts will not be disabled.
PASSING_PARTITION	string	No	Determines if account partitions will be identified on the account. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: partitions will be identified. `N`: partitions will not be identified.
DISABLE_PARTITIONS	string	No	Determines if account partitions will also be disabled. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: partitions will be disabled. `N`: partitions will not be disabled.
DISABLE_GROUPS	string	No	Determines if the assigned account group will also be disabled. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: the group will also be disabled. `N`: the group will not be disabled.
DISABLE_ADDRESSES	string	No	Determines if accounts with the same address as the identified account will also be disabled. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: accounts with matching addresses will also be disabled. `N`: accounts with matching addresses will not be disabled.
CLEAR_ALARMS	string	No	Determines if pending alarms on the account are cleared once the account is placed on test. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: any pending alarms on the account will be system handled. `N`: any pending alarms on the account will remain in pending to be handled by an appropriate operator.
LIVE_NOTIFY	string	No	Determines if select individuals are notified when the account is disabled. Accepts `Y` or `N`. Defaults to `N` if left blank. `Y`: applicable contacts will be notified when the disable takes effect. `N`: contacts will not be notified about disables.
LIVE_NOTIFY_ADDRESS	string	No	Determines the phone numbers or email addresses that will be notified (`60` character max). `LIVE_NOTIFY` must be set to `Y` to identify numbers/emails. Expects 10-digit phone numbers and emails in a comma delimited list.
LIVE_NOTIFY_FMT	string	No	Determines the information included in the notification (`128` character max). `%a%`: Account Number `%st%`: Event time in `HH:MM` format `%cc%`: SEIA Code if applicable `%z1%`: Zone Code 1 `%z2%`: Zone Code 2 `%ar%`: Area if applicable `%ht%`: History message `%zm%`: Message 2 Default Message: `%a% %st% - (%cc%) %z1% %z2% %ar% %ht% %zm%` Example text: `00TEST 03:26 - (BG) 12993 Burglary Status`
CHG_REASON	string	No	Determines the message written to history when a disable is updated (`30` character max).
MINUTES	integer	No	Determines the number of minutes the account will be disabled for (`4` character max).
LOG_MESSAGE	string	No	Defines message text that will be saved to the account’s history report (`30` 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="XMDISUTL"' \
--form 'OPTION="DISABLE"' \
--form 'ACCOUNT_NUMBER="KMN11"' \
--form 'DISINFO="DISINFO field"' \
--form 'DISABLE_ZONES="ALL"' \
--form 'DISABLE_TYPES=""' \
--form 'EXCEPT_THIS_ZONE=""' \
--form 'DISABLE_RUNAWAY=""' \
--form 'TIME_INCLUSIVE=""' \
--form 'DISABLE_BEGIN_DATE="250206"' \
--form 'DISABLE_BEGIN_TIME="0700"' \
--form 'DISABLE_END_DATE="250206"' \
--form 'DISABLE_END_TIME="1200"' \
--form 'VALID_DAYS="NYYYYYN"' \
--form 'DISABLE_LINKS=""' \
--form 'PASSING_PARTITION=""' \
--form 'DISABLE_PARTITIONS=""' \
--form 'DISABLE_GROUPS=""' \
--form 'DISABLE_ADDRESSES=""' \
--form 'CLEAR_ALARMS=""' \
--form 'LIVE_NOTIFY=""' \
--form 'LIVE_NOTIFY_ADDRESS=""' \
--form 'CHG_REASON="CHG_REASON"' \
--form 'ADD_REASON="ADD_REASON"' \
--form 'MINUTES=""' \
--form 'LOG_MESSAGE="Log Message"' \
--form 'MATCH_FIELD=""' \
--form 'UNIQUE_KEY="'\''"'

Example response

{
    "A": "B",
    "ALDISCHD": {
        "COMPANY_NAME": "Notes Testing Account",
        "STREET_NO": "12345",
        "STREET_NAME1": "N",
        "STREET_NAME2": "Rose Ave",
        "CITY": "BAY CITY",
        "STATE": "MI",
        "COUNTRY": "USA",
        "ZIPCODE": "48706",
        "ACCOUNT_NUMBER": "KMN11",
        "UNIQUE_KEY": "'",
        "FIRST_ZONE": "ALL",
        "BEGIN_DATE": "250206",
        "BEGIN_TIME": "0700",
        "END_DATE": "250206",
        "END_TIME": "1200",
        "INFORMATION": "DISINFO FIELD",
        "VALID_SUNDAY": "N",
        "VALID_MONDAY": "Y",
        "VALID_TUESDAY": "Y",
        "VALID_WEDNESDAY": "Y",
        "VALID_THURSDAY": "Y",
        "VALID_FRIDAY": "Y",
        "VALID_SATURDAY": "N",
        "NTD_BEGIN_DATE": "739290.29167",
        "NTD_END_DATE": "739290.50068",
        "DEALER": "KATE01",
        "EXCEPT_THIS_ZONE": "N",
        "TIME_INCLUSIVE": "Y",
        "MATCH_FIELD": "v]",
        "NTD_ON_TEST": "739290.29167",
        "NTD_OFF_TEST": "739290.50068",
        "NTD_LAST_ON_TEST": "739290.29167",
        "OPR": "KK",
        "NTD_ACCT_TZ_OFFSET": "0"
    },
    "ACCOUNT_TIME": {
        "SERVER_DATE": "02/05/2025 13:25:39",
        "ACCOUNT_DATE": "02/05/2025 13:25:39",
        "ACCOUNT_TIME_ZONE": "EST",
        "TZ_FACTOR": "0"
    }
}

Remove disable

Remove disable entries on the subscriber account.

Supported attributes

Attribute	Type	Required	Description
*setMethod	string	Yes	Determines the endpoint you are calling. Must be `XMDISUTL` to manage disables.
OPTION	string	Yes	Determines the method you will be using. Use `ENABLE` when removing disables.
ACCOUNT_NUMBER	string	Yes	The subscriber account number (`9` character max).
UNIQUE_KEY	string	Yes	Determines the unique ID of the disable being removed (`5` character max).
MATCH_FIELD	string	No	Determines which disables should be removed by specifying the `MATCH_FIELD` assigned to disables upon creation (`5` character max). This is only necessary if you are deleting multiple disables assigned to the same `MATCH_FIELD`. The match field ID is included within the response received after adding or editing a disable.
DEL_REASON	string	No	Determines the message written to history when a disable is deleted from the account (`30` 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="XMDISUTL"' \
--form 'OPTION="ENABLE"' \
--form 'ACCOUNT_NUMBER="KMN11"' \
--form 'MATCH_FIELD=""' \
--form 'DEL_REASON="delete"' \
--form 'UNIQUE_KEY="'\''"'

Example response

{
    "A": "B",
    "ACCOUNT_TIME": {
        "SERVER_DATE": "02/05/2025 13:28:50",
        "ACCOUNT_DATE": "02/05/2025 13:28:50",
        "ACCOUNT_TIME_ZONE": "EST",
        "TZ_FACTOR": "0"
    }
}

List status

Get a list of the disables currently active on the account.

Supported attributes

Attribute	Type	Required	Description
*setMethod	string	Yes	Determines the endpoint you are calling. Must be `XMDISUTL` to manage disables.
OPTION	string	Yes	Determines the method you will be using. Use `ENABLE` when removing disables.
ACCOUNT_NUMBER	string	Yes	The subscriber account number (`9` character max).
SEND_ALL	string	No	Determines if disables on all accounts the user has access to should display. This attribute cannot be used in conjunction with `ACCOUNT_NUMBER`. Accepts `TRUE` or `FALSE`. TRUE: Displays all disables assigned to accessible accounts. FALSE: Displays all disables assigned to accessible partitioned accounts.

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="XMDISUTL"' \
--form 'OPTION="STATUS"' \
--form 'ACCOUNT_NUMBER="KMN10"'
--form 'SEND_ALL="TRUE"'

Example response

{
    "A": "B",
    "ACCOUNT_TIME": {
        "SERVER_DATE": "01/31/2025 14:51:24",
        "ACCOUNT_DATE": "01/31/2025 14:51:24",
        "ACCOUNT_TIME_ZONE": "EST",
        "TZ_FACTOR": "0"
    }
}

{
    "A": "B",
    "ALDISCHD": {
        "COMPANY_NAME": "API TESTING",
        "STREET_NO": "1234",
        "STREET_NAME1": "N",
        "STREET_NAME2": "JONESRD.",
        "ADDTL_ADDRESS": "SUITE15",
        "CITY": "ESSEXVILLE",
        "STATE": "MI",
        "COUNTRY": "USA",
        "ZIPCODE": "48732",
        "ACCOUNT_NUMBER": "KMN10",
        "UNIQUE_KEY": "!",
        "FIRST_ZONE": "ALL",
        "BEGIN_DATE": "040225",
        "BEGIN_TIME": "0900",
        "END_DATE": "040225",
        "END_TIME": "1400",
        "INFORMATION": "TESTING XMDISUTL",
        "VALID_SUNDAY": "N",
        "VALID_MONDAY": "Y",
        "VALID_TUESDAY": "Y",
        "VALID_WEDNESDAY": "Y",
        "VALID_THURSDAY": "Y",
        "VALID_FRIDAY": "Y",
        "VALID_SATURDAY": "N",
        "NTD_BEGIN_DATE": "731638.37500",
        "NTD_END_DATE": "731638.58402",
        "DEALER": "KATE01",
        "EXCEPT_THIS_ZONE": "Y",
        "TIME_INCLUSIVE": "N",
        "MATCH_FIELD": "v[",
        "NTD_ON_TEST": "999999.99999",
        "NTD_OFF_TEST": "731638.58402",
        "NTD_LAST_ON_TEST": "739284.62300",
        "OPR": "KK",
        "NTD_ACCT_TZ_OFFSET": "0"
    },
    "ACCOUNT_TIME": {
        "SERVER_DATE": "01/31/2025 14:57:11",
        "ACCOUNT_DATE": "01/31/2025 14:57:11",
        "ACCOUNT_TIME_ZONE": "EST",
        "TZ_FACTOR": "0"
    }
}

Possible error messages

Invalid disable option

Verify the specified OPTION is one of the valid types.

{
    "A": "B",
    "RESULTS": {
        "RESULT": "ERROR",
        "ERRORCODE": "010",
        "ERRORMESSAGE": "Invalid disable option"
    }
}

Account doesn’t exist

Verify the specified account number is valid.

{
    "A": "B",
    "STATUS": "ERROR: The selected account does not exist.",
    "RESULTS": {
        "RESULT": "ERROR",
        "ERRORCODE": "400",
        "ERRORMESSAGE": " The selected account does not exist."
    }
}

Information field cannot be blank

Verify the ADD_REASON field is populated with information.

{
    "A": "B",
    "STATUS": "ERROR",
    "MESSAGE": "Information field cannot be blank."
}

No zone specified

Verify the specified zones are valid.

{
    "A": "B",
    "RESULTS": {
        "RESULT": "ERROR",
        "ERRORCODE": "030",
        "ERRORMESSAGE": "Unable to perform operation",
        "RESTRICTIONMESSAGE": "No Zone Specified"
    }
}

Account number mismatch

Verify the specified UNIQUE_KEY is assigned to a disable that exists on the specified account number.

{
    "A": "B",
    "RESULTS": {
        "RESULT": "ERROR",
        "ERRORCODE": "040",
        "ERRORMESSAGE": "-     -"
    }
}

Record to update not found

Verify the specified UNIQUE_KEY is valid.

{
    "A": "B",
    "RESULTS": {
        "RESULT": "ERROR",
        "ERRORCODE": "031",
        "ERRORMESSAGE": "Record to update not found"
    }
}

End date less than begin date

Verify the specified date range is accurate.

{
    "A": "B",
    "RESULTS": {
        "RESULT": "ERROR",
        "ERRORCODE": "021",
        "ERRORMESSAGE": "End date less than begin date"
    }
}

Max disable limit exceeded

Verify the specified time frame is less than or equal to your user defined Max Disable Time.

{
    "A": "B",
    "RESULTS": {
        "RESULT": "ERROR",
        "ERRORCODE": "023",
        "ERRORMESSAGE": "Max disable limit exceeded 2 hours)" 
    }
}

Define time frame

Verify the MINUTES attribute or the DISABLE_BEGIN_TIME and DISABLE_END_TIME attributes are defined.

{
    "A": "B",
    "RESULTS": {
        "RESULT": "ERROR",
        "ERRORCODE": "022",
        "ERRORMESSAGE": "The number of minutes or begin and end time must be specified." 
    }
}

Invalid date/time

Verify the specified time frame is accurate.

{
    "A": "B",
    "RESULTS": {
        "RESULT": "ERROR",
        "ERRORCODE": "020",
        "ERRORMESSAGE": "Invalid date/time "
    }
}

Unprocessed option

Verify the defined OPTION is valid.

{
    "A": "B",
    "RESULTS": {
        "RESULT": "ERROR",
        "ERRORCODE": "011",
        "ERRORMESSAGE": "Unprocessed Option"
    }
}

Unable to perform operation

Verify the defined OPTION is valid.

{
    "A": "B",
    "RESULTS": {
        "RESULT": "ERROR",
        "ERRORCODE": "030",
        "ERRORMESSAGE": "Unable to perform operation"
    }
}

Manage Account Disables

Use cases #

Date formats #

Add disable #

Supported attributes #

Example request #

Example response #

Edit disable #

Overwrite warning #

Supported attributes #

Example request #

Example response #

Remove disable #

Supported attributes #

Example request #

Example response #

List status #

Supported attributes #

Example request #

Example response #

Possible error messages #

Invalid disable option #

Account doesn’t exist #

Information field cannot be blank #

No zone specified #

Account number mismatch #

Record to update not found #

End date less than begin date #

Max disable limit exceeded #

Define time frame #

Invalid date/time #

Unprocessed option #

Unable to perform operation #

Use cases

Date formats

Add disable

Supported attributes

Example request

Example response

Edit disable

Overwrite warning

Supported attributes

Example request

Example response

Remove disable

Supported attributes

Example request

Example response

List status

Supported attributes

Example request

Example response

Possible error messages

Invalid disable option

Account doesn’t exist

Information field cannot be blank

No zone specified

Account number mismatch

Record to update not found

End date less than begin date

Max disable limit exceeded

Define time frame

Invalid date/time

Unprocessed option

Unable to perform operation