Manage Authorities

This documentation will describe the Manage Authorities (XMAUTHMT) endpoint. This endpoint is responsible for managing authority information available on the system. See the Authority Maintenance documentation for more information on managing authorities within Matrix.

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

Use Cases

  • Data entering authorities
  • Updating existing authorities
  • Deleting authorities

Add authorities

Create profiles for new authorities. When adding authorities, users will define the authority type (police, fire, medic, or guard) via the selected method and certain attributes.

Add police

Create a profile for law enforcement.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMAUTHMT to manage authorities.
OPTIONstringYesDetermines the method you will be using. Use CREATE_AUTHORITY_POLICE when adding a police authority.
POLICE_NAMEstringYesThe title of the authority (20 character max).
PERSONAL_INFOstringNoA brief description of the authority (30 character max).
POLICE_PHONEstringYesDetermines the primary telephone number used to contact the authority (16 character max).
PHONE_EXTENSIONstringNoIf applicable, determines the phone extension used to contact the authority (8 character max).
POLICE_PHONE_FstringYesDetermines the format that should apply to the defined phone number (1 character max).
REGIONstringNoDetermines the county, state, or region where the authority is located (6 character max).
COUNTRYstringNoDetermines the country (USA, CAN, MEX, etc.) where the authority is located (3 character max).
OPTIONAL_SCRIPTstringNoDetermines the script operators should use when when contacting the authority (8 character max).
SEND_DISPATCH_LETTERstringNoDetermines if appropriate contacts will be informed via email when the authority is dispatched. Accepts: Y or N.
INCLUDE_EXCLUDE_LISTstringNoIf a dispatch letter is being sent, determines the include/exclude list that should be used when sending the letter (6 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="XMAUTHMT"' \
--form 'OPTION="CREATE_AUTHORITY_POLICE"' \
--form 'POLICE_NAME="New Police"' \
--form 'POLICE_PHONE="5553332232"' \
--form 'REGION="A123"' \
--form 'POLICE_PHONE_F="\!"' \
--form 'PERSONAL_INFO="DRR2"' \
--form 'PHONE_EXTENSION="1234"' \
--form 'OPTIONAL_SCRIPT=""' \
--form 'COUNTRY="USA"' \
--form 'SEND_DISPATCH_LETTER="Y"' \
--form 'INCLUDE_EXCLUDE_LIST="ACCT"'

Example response

{
    "STATUS": "SUCCESS",
    "CODE": "XP01S"
}

The resulting CODE is the AUTHORITY_CODE assigned to the authority.

Add fire

Create a profile for a fire department.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMAUTHMT to manage authorities.
OPTIONstringYesDetermines the method you will be using. Use CREATE_AUTHORITY_FIRE when adding a fire authority.
FIRE_NAMEstringYesThe title of the authority (20 character max).
PERSONAL_INFOstringNoA brief description of the authority (30 character max).
FIRE_PHONEstringYesDetermines the primary telephone number used to contact the authority (16 character max).
PHONE_EXTENSIONstringNoIf applicable, determines the phone extension used to contact the authority (8 character max).
FIRE_PHONE_FstringYesDetermines the format that should apply to the defined phone number (1 character max).
REGIONstringNoDetermines the county, state, or region where the authority is located (6 character max).
COUNTRYstringNoDetermines the country (USA, CAN, MEX, etc.) where the authority is located (3 character max).
OPTIONAL_SCRIPTstringNoDetermines the script operators should use when when contacting the authority (8 character max).
SEND_DISPATCH_LETTERstringNoDetermines if appropriate contacts will be informed via email when the authority is dispatched. Accepts: Y or N.
INCLUDE_EXCLUDE_LISTstringNoIf a dispatch letter is being sent, determines the include/exclude list that should be used when sending the letter (6 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="XMAUTHMT"' \
--form 'OPTION="CREATE_AUTHORITY_FIRE"' \
--form 'FIRE_NAME="New Fire"' \
--form 'FIRE_PHONE="5558487373"' \
--form 'REGION="A123"' \
--form 'FIRE_PHONE_F="\!"' \
--form 'PERSONAL_INFO="DRR2"' \
--form 'PHONE_EXTENSION="1234"' \
--form 'OPTIONAL_SCRIPT=""' \
--form 'COUNTRY="USA"' \
--form 'SEND_DISPATCH_LETTER="Y"' \
--form 'INCLUDE_EXCLUDE_LIST="ACCT"'

Example response

{
    "STATUS": "SUCCESS",
    "CODE": "XF01_"
}

The resulting CODE is the AUTHORITY_CODE assigned to the authority.

Add medic

Create a profile for emergency medical personnel.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMAUTHMT to manage authorities.
OPTIONstringYesDetermines the method you will be using. Use CREATE_AUTHORITY_MEDIC when adding a medic authority.
MEDICAL_NAMEstringYesThe title of the authority (20 character max).
PERSONAL_INFOstringNoA brief description of the authority (30 character max).
MEDICAL_PHONEstringYesDetermines the primary telephone number used to contact the authority (16 character max).
PHONE_EXTENSIONstringNoIf applicable, determines the phone extension used to contact the authority (8 character max).
MEDICAL_PHONE_FstringYesDetermines the format that should apply to the defined phone number (1 character max).
REGIONstringNoDetermines the county, state, or region where the authority is located (6 character max).
COUNTRYstringNoDetermines the country (USA, CAN, MEX, etc.) where the authority is located (3 character max).
OPTIONAL_SCRIPTstringNoDetermines the script operators should use when when contacting the authority (8 character max).
SEND_DISPATCH_LETTERstringNoDetermines if appropriate contacts will be informed via email when the authority is dispatched. Accepts: Y or N.
INCLUDE_EXCLUDE_LISTstringNoIf a dispatch letter is being sent, determines the include/exclude list that should be used when sending the letter (6 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="XMAUTHMT"' \
--form 'OPTION="CREATE_AUTHORITY_MEDIC"' \
--form 'MEDICAL_NAME="New MEDIC"' \
--form 'MEDICAL_PHONE="5559756293"' \
--form 'REGION="A123"' \
--form 'MEDICAL_PHONE_F="\!"' \
--form 'PERSONAL_INFO="DRR2"' \
--form 'PHONE_EXTENSION="1234"' \
--form 'OPTIONAL_SCRIPT=""' \
--form 'COUNTRY="USA"' \
--form 'SEND_DISPATCH_LETTER="Y"' \
--form 'INCLUDE_EXCLUDE_LIST="ACCT"'

Example response

{
    "STATUS": "SUCCESS",
    "CODE": "XM02="
}

The resulting CODE is the AUTHORITY_CODE assigned to the authority.

Add guard

Create a profile for private security personnel.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMAUTHMT to manage authorities.
OPTIONstringYesDetermines the method you will be using. Use CREATE_AUTHORITY_GUARD when adding a guard authority.
GUARD_NAMEstringYesThe title of the authority (20 character max).
PERSONAL_INFOstringNoA brief description of the authority (30 character max).
GUARD_PHONEstringYesDetermines the primary telephone number used to contact the authority (16 character max).
PHONE_EXTENSIONstringNoIf applicable, determines the phone extension used to contact the authority (8 character max).
GUARD_PHONE_FstringYesDetermines the format that should apply to the defined phone number (1 character max).
REGIONstringNoDetermines the county, state, or region where the authority is located (6 character max).
COUNTRYstringNoDetermines the country (USA, CAN, MEX, etc.) where the authority is located (3 character max).
OPTIONAL_SCRIPTstringNoDetermines the script operators should use when when contacting the authority (8 character max).
SEND_DISPATCH_LETTERstringNoDetermines if appropriate contacts will be informed via email when the authority is dispatched. Accepts: Y or N.
INCLUDE_EXCLUDE_LISTstringNoIf a dispatch letter is being sent, determines the include/exclude list that should be used when sending the letter (6 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="XMAUTHMT"' \
--form 'OPTION="CREATE_AUTHORITY_GUARD"' \
--form 'GUARD_NAME="New Guard"' \
--form 'GUARD_PHONE="5550983482"' \
--form 'REGION="A123"' \
--form 'GUARD_PHONE_F="\!"' \
--form 'PERSONAL_INFO="DRR2"' \
--form 'PHONE_EXTENSION="1234"' \
--form 'OPTIONAL_SCRIPT=""' \
--form 'COUNTRY="USA"' \
--form 'SEND_DISPATCH_LETTER="Y"' \
--form 'INCLUDE_EXCLUDE_LIST="ACCT"'

Example response

{
    "STATUS": "SUCCESS",
    "CODE": "00004"
}

The resulting CODE is the AUTHORITY_CODE assigned to the authority.

Edit authorities

Update existing authority information. When editing authorities, users will define the authority type (police, fire, medic, or guard) via the selected method and certain attributes.

Edit police

Update a law enforcement authority.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMAUTHMT to manage authorities.
OPTIONstringYesDetermines the method you will be using. Use CREATE_AUTHORITY_POLICE when editing a police authority.
AUTHORITY_CODEstringYesDetermines the identifier assigned to the authority being edited.
POLICE_NAMEstringNoThe title of the authority (20 character max).
PERSONAL_INFOstringNoA brief description of the authority (30 character max).
POLICE_PHONEstringYesDetermines the primary telephone number used to contact the authority (16 character max).
PHONE_EXTENSIONstringNoIf applicable, determines the phone extension used to contact the authority (8 character max).
POLICE_PHONE_FstringYesDetermines the format that should apply to the defined phone number (1 character max).
REGIONstringNoDetermines the county, state, or region where the authority is located (6 character max).
COUNTRYstringNoDetermines the country (USA, CAN, MEX, etc.) where the authority is located (3 character max).
OPTIONAL_SCRIPTstringNoDetermines the script operators should use when when contacting the authority (8 character max).
SEND_DISPATCH_LETTERstringNoDetermines if appropriate contacts will be informed via email when the authority is dispatched. Accepts: Y or N.
INCLUDE_EXCLUDE_LISTstringNoIf a dispatch letter is being sent, determines the include/exclude list that should be used when sending the letter (6 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="XMAUTHMT"' \
--form 'OPTION="CREATE_AUTHORITY_POLICE"' \
--form 'AUTHORITY_CODE="XP01S"' \
--form 'POLICE_NAME="Edit Police"' \
--form 'POLICE_PHONE="(555) 333-2232"' \
--form 'REGION="A123"' \
--form 'POLICE_PHONE_F="\!"' \
--form 'PERSONAL_INFO="DRR2"' \
--form 'PHONE_EXTENSION="1234"' \
--form 'OPTIONAL_SCRIPT=""' \
--form 'COUNTRY="USA"' \
--form 'SEND_DISPATCH_LETTER="Y"' \
--form 'INCLUDE_EXCLUDE_LIST="ACCT"'

Example response

{
    "STATUS": "SUCCESS"
}

Edit fire

Update a fire department authority.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMAUTHMT to manage authorities.
OPTIONstringYesDetermines the method you will be using. Use CREATE_AUTHORITY_FIRE when editing a fire authority.
AUTHORITY_CODEstringYesDetermines the identifier assigned to the authority being edited.
FIRE_NAMEstringYesThe title of the authority (20 character max).
PERSONAL_INFOstringNoA brief description of the authority (30 character max).
FIRE_PHONEstringYesDetermines the primary telephone number used to contact the authority (16 character max).
PHONE_EXTENSIONstringNoIf applicable, determines the phone extension used to contact the authority (8 character max).
FIRE_PHONE_FstringYesDetermines the format that should apply to the defined phone number (1 character max).
REGIONstringNoDetermines the county, state, or region where the authority is located (6 character max).
COUNTRYstringNoDetermines the country (USA, CAN, MEX, etc.) where the authority is located (3 character max).
OPTIONAL_SCRIPTstringNoDetermines the script operators should use when when contacting the authority (8 character max).
SEND_DISPATCH_LETTERstringNoDetermines if appropriate contacts will be informed via email when the authority is dispatched. Accepts: Y or N.
INCLUDE_EXCLUDE_LISTstringNoIf a dispatch letter is being sent, determines the include/exclude list that should be used when sending the letter (6 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="XMAUTHMT"' \
--form 'OPTION="CREATE_AUTHORITY_FIRE"' \
--form 'AUTHORITY_CODE="XF01_"' \
--form 'FIRE_NAME="Edit Fire"' \
--form 'FIRE_PHONE="5558487373"' \
--form 'REGION="A123"' \
--form 'FIRE_PHONE_F="\!"' \
--form 'PERSONAL_INFO="DRR2"' \
--form 'PHONE_EXTENSION="1234"' \
--form 'OPTIONAL_SCRIPT=""' \
--form 'COUNTRY="USA"' \
--form 'SEND_DISPATCH_LETTER="Y"' \
--form 'INCLUDE_EXCLUDE_LIST="ACCT"'

Example response

{
    "STATUS": "SUCCESS"
}

Edit medic

Update an emergency medical authority.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMAUTHMT to manage authorities.
OPTIONstringYesDetermines the method you will be using. Use CREATE_AUTHORITY_MEDIC when editing a medic authority.
AUTHORITY_CODEstringYesDetermines the identifier assigned to the authority being edited.
MEDICAL_NAMEstringYesThe title of the authority (20 character max).
PERSONAL_INFOstringNoA brief description of the authority (30 character max).
MEDICAL_PHONEstringYesDetermines the primary telephone number used to contact the authority (16 character max).
PHONE_EXTENSIONstringNoIf applicable, determines the phone extension used to contact the authority (8 character max).
MEDICAL_PHONE_FstringYesDetermines the format that should apply to the defined phone number (1 character max).
REGIONstringNoDetermines the county, state, or region where the authority is located (6 character max).
COUNTRYstringNoDetermines the country (USA, CAN, MEX, etc.) where the authority is located (3 character max).
OPTIONAL_SCRIPTstringNoDetermines the script operators should use when when contacting the authority (8 character max).
SEND_DISPATCH_LETTERstringNoDetermines if appropriate contacts will be informed via email when the authority is dispatched. Accepts: Y or N.
INCLUDE_EXCLUDE_LISTstringNoIf a dispatch letter is being sent, determines the include/exclude list that should be used when sending the letter (6 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="XMAUTHMT"' \
--form 'OPTION="CREATE_AUTHORITY_MEDIC"' \
--form 'MEDICAL_NAME="Edit Medic"' \
--form 'AUTHORITY_CODE="XM02="' \
--form 'MEDICAL_PHONE="5559756293"' \
--form 'REGION="A123"' \
--form 'MEDICAL_PHONE_F="\!"' \
--form 'PERSONAL_INFO="DRR2"' \
--form 'PHONE_EXTENSION="1234"' \
--form 'OPTIONAL_SCRIPT=""' \
--form 'COUNTRY="USA"' \
--form 'SEND_DISPATCH_LETTER="Y"' \
--form 'INCLUDE_EXCLUDE_LIST="ACCT"'

Example response

{
    "STATUS": "SUCCESS"
}

Edit guard

Update a private security authority.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMAUTHMT to manage authorities.
OPTIONstringYesDetermines the method you will be using. Use CREATE_AUTHORITY_GUARD when editing a guard authority.
AUTHORITY_CODEstringYesDetermines the identifier assigned to the authority being edited.
GUARD_NAMEstringYesThe title of the authority (20 character max).
PERSONAL_INFOstringNoA brief description of the authority (30 character max).
GUARD_PHONEstringYesDetermines the primary telephone number used to contact the authority (16 character max).
PHONE_EXTENSIONstringNoIf applicable, determines the phone extension used to contact the authority (8 character max).
GUARD_PHONE_FstringYesDetermines the format that should apply to the defined phone number (1 character max).
REGIONstringNoDetermines the county, state, or region where the authority is located (6 character max).
COUNTRYstringNoDetermines the country (USA, CAN, MEX, etc.) where the authority is located (3 character max).
OPTIONAL_SCRIPTstringNoDetermines the script operators should use when when contacting the authority (8 character max).
SEND_DISPATCH_LETTERstringNoDetermines if appropriate contacts will be informed via email when the authority is dispatched. Accepts: Y or N.
INCLUDE_EXCLUDE_LISTstringNoIf a dispatch letter is being sent, determines the include/exclude list that should be used when sending the letter (6 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="XMAUTHMT"' \
--form 'OPTION="CREATE_AUTHORITY_GUARD"' \
--form 'AUTHORITY_CODE="00001"' \
--form 'GUARD_NAME="Edit Guard"' \
--form 'GUARD_PHONE="(555) 123-1231"' \
--form 'REGION="A123"' \
--form 'GUARD_PHONE_F="\!"' \
--form 'PERSONAL_INFO="DRR2"' \
--form 'PHONE_EXTENSION="1234"' \
--form 'OPTIONAL_SCRIPT=""' \
--form 'COUNTRY="USA"' \
--form 'SEND_DISPATCH_LETTER="Y"' \
--form 'INCLUDE_EXCLUDE_LIST="ACCT"'

Example response

{
    "STATUS": "SUCCESS"
}

Delete authorities

Remove existing authorities from the system.

Supported attributes

AttributeTypeRequiredDescription
*setMethodstringYesDetermines the endpoint you are calling. Must be XMAUTHMT to manage authorities.
OPTIONstringYesDetermines the method you will be using. Use DELETE_AUTHORITY when removing authorities.
AUTHORITY_CODEstringYesDetermines the identifier assigned to the authority being deleted.
AUTHORITY_TYPEstringYesDetermines the type assigned to the authority being deleted.
1: Fire
2: Police
3: Medic
4: Guard
NEW_CODEstringYesDetermines the identifier assigned to the authority that will replace the deleted authority.

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="XMAUTHMT"' \
--form 'OPTION="DELETE_AUTHORITY"' \
--form 'AUTHORITY_CODE="00004"' \
--form 'AUTHORITY_TYPE="4"' \
--form 'NEW_CODE="00001"'

Example response

{
    "STATUS": "SUCCESS"
}

Possible error messages

Duplicate phone number

The specified phone number is assigned to an existing authority. Verify the phone number is unique to the authority you’re managing.

{
    "STATUS": "ERROR",
    "MESSAGE": "An authority with that phone number already exists."
}