Data Entry Introduction

This documentation will describe how to lock and release accounts when using the available Data Entry (XMMDALL) endpoints. These endpoints are responsible for managing account information.

When managing account information, users must first lock the account they are working on. Once work is complete, they must then release the account. The lock and release requests are described below.

Lock accounts

Lock an account prior to editing its information.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMMDALLM to lock accounts.
OPTIONstringYesDetermines the method you will be using. Must be LOAD to lock the account. This will return your HIDDEN_KEY required to validate XMMDALL requests.
ACCOUNT_NUMBERstringYesDetermines the account number you’ll be working on and need to lock (9 character max).
RESERVED_MDAstringYesDetermines the terminal session ID the system will use. Must begin with an underscore. Example: _DOC.

The determined RESERVED_MDA ID must be used within the respective XMMDALL requests used to edit the account. This ID is how the system organizes requests.

HOWEVER: if multiple accounts are being updated simultaneously, the user must use unique IDs for each account to properly execute the requests.

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=XMMDALLM' \
--form OPTION=LOAD \
--form ACCOUNT_NUMBER=00DICE \
--form RESERVED_MDA=_DOC

Example response

The below example is truncated. The LOAD option produces the entire ALSUBSCR record. See the Subscriber Record Reference documentation for more information on this record.

  },
  "ACCOUNT_EXISTS": "Y",
  "RATE_TABLE_LABEL_INFO": "Rate Table     ",
  "USES_CVR": "Y",
  "HIDDEN": {
    "HIDDEN_KEY": "0000000000000000.0000000000000000000000000000000000000000000000000000000"
  },

The HIDDEN_KEY is used in other XMMDALL requests to validate the request.

Release accounts

Release an account after edits are complete.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMMDALLM to release accounts.
OPTIONstringYesDetermines which method you will be using. Must be RELEASE to release an account.
ACCOUNT_NUMBERstringYesDetermines the account number that should be released to (9 character max).
RESERVED_MDAstringYesThe terminal session ID. Use the same ID defined when locking.
CHECK_RELEASEstringYesMust be set to Y to release the account.

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=XMMDALLM' \
--form OPTION=RELEASE \
--form ACCOUNT_NUMBER=00KEVIN \
--form RESERVED_MDA=_DOC \
--form CHECK_RELEASE=Y

Example response 

{
  "RESULTS": "RELEASED _DOC"
}
← Manage Account Information
Load Contact →