Customer Contacts

This documentation defines the Customer Contacts (ARCONTCT) schema fields.

Please Note This documentation defines the most relevant fields. Treat the response from the View Table Schema (XMGETFMT) endpoint as the authoritative field list for any specific site.

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.

Field definitions

#NameDescriptionLengthPadding Type
1AR_NUMBERThe unique accounting identifier assigned to the customer.10Pad with trailing spaces.
2LIST_NUMBERThe unique ID assigned to the contact. Users can use the Passcode Lookup or Load Contact endpoints to view contact List Numbers.4Right justify and pad with leading zeros.
3POSITION_CODEThe contact’s position or title.6Pad with trailing spaces.
4TITLEThe contact’s preferred honorific (Mr., Ms., etc.).4Pad with trailing spaces.
5FIRST_NAMEThe contact’s first name.25Pad with trailing spaces.
6MIDDLE_INITIALThe initial of the contact’s middle name.2Pad with trailing spaces.
7LAST_NAMEThe contact’s last name.30Pad with trailing spaces.
8STREET_NOThe building number of the contact’s address.8Pad with trailing spaces.
9STREET_NAME1The street direction of the contact’s address.2Pad with trailing spaces.
10STREET_NAME2The street name of the contact’s address.28Pad with trailing spaces.
11ADDTL_ADDRESSAdditional address information such as P.O. box or apartment number.28Pad with trailing spaces.
12ADDTL_ADDRESS_2Additional address information.28Pad with trailing spaces.
13ADDTL_ADDRESS_3Additional address information.28Pad with trailing spaces.
14CITYThe city name of the contact’s address.18Pad with trailing spaces.
15STATEThe state or province abbreviation of the contact’s address.3Pad with trailing spaces.
16COUNTRYThe country code of the contact’s address.3Pad with trailing spaces.
17ZIPCODEThe postal code of the contact’s address.10Pad with trailing spaces.
18PHONE_NUMBERThe contact’s primary phone number.16Pad with trailing spaces.
19PHONE_EXTENSIONIf applicable, the extension number used to direct dial the contact.4Pad with trailing spaces.
20FAX_NUMBERIf applicable, the number used to reach this contact via fax.16Pad with trailing spaces.
21LAST_OPERATORThe operator code of the individual who last updated the contact’s profile.3Pad with trailing spaces.
22LAST_ENTRYThe NTD date and time of the last update made to the contact’s profile.6Pad with trailing spaces.
23ACTIVEDetermines if the contact is active within the system. Accepts: Y or N.1Pad with trailing spaces.
24CONTACT_INFO_1Contact identifier field 1.25Pad with trailing spaces.
25CONTACT_INFO_2Contact identifier field 2.25Pad with trailing spaces.
26BRANCH_IDThe ID of the branch the contact belongs to.3Pad with trailing spaces.
27BEGIN_TIMEThe time of day the contact becomes available.4Pad with trailing spaces.
28END_TIMEThe time of day the contact is no longer available.4Pad with trailing spaces.
29TIME_ZNThe time zone the contact lives in.3Pad with trailing spaces.
30PHONE_NUMBER_FDetermines the phone number masking applied to the contact’s phone number. For information on the available masking options, see the View Phone Formats endpoint documentation.1Pad with trailing spaces.
31FAX_NUMBER_FDetermines the phone number masking applied to the contact’s fax number. For information on the available masking options, see the View Phone Formats endpoint documentation.1Pad with trailing spaces.
32DEFAULT_SORT_NOThe order the contact will display in.5Pad with trailing spaces.
33SORT_PHONEThe contact’s phone number without any formatting for sorting/searching purposes.16Pad with trailing spaces.
34SMS_NOTIFYDetermines if this contact can be contacted via SMS. Accepts: Y or N.1Pad with trailing spaces.

Example request 

curl --request GET \
--url 'https://global-rest.ci.matrixmcloud.com/rest/rest.php?dataSource=dice&*view=arcontct&*limit=1&*blanks=all' \
--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' \

Example response 

{
  "ARCONTCT": [
    {
      "AR_NUMBER": "000000021",
      "LIST_NUMBER": "0002",
      "POSITION_CODE": "MANAGE",
      "TITLE": "MS",
      "FIRST_NAME": "TERI",
      "MIDDLE_INITIAL": "L",
      "LAST_NAME": "WALKER",
      "STREET_NO": "991",
      "STREET_NAME1": "E",
      "STREET_NAME2": "OVILLA ROAD",
      "ADDTL_ADDRESS": "SUITE A",
      "ADDTL_ADDRESS_2": "",
      "ADDTL_ADDRESS_3": "",
      "CITY": "RED OAK",
      "STATE": "TX",
      "COUNTRY": "USA",
      "ZIPCODE": "75154",
      "PHONE_NUMBER": "  (555) 234-2468",
      "PHONE_EXTENSION": "301",
      "FAX_NUMBER": "(555) 234-6895",
      "LAST_OPERATOR": "JS",
      "LAST_ENTRY": "733295",
      "ACTIVE": "Y",
      "CONTACT_INFO_1": "",
      "CONTACT_INFO_2": "",
      "BRANCH_ID": "",
      "BEGIN_TIME": "0800",
      "END_TIME": "1700",
      "TIME_ZN": "EST",
      "PHONE_NUMBER_F": "",
      "FAX_NUMBER_F": "",
      "DEFAULT_SORT_NO": "00002",
      "SORT_PHONE": "5552342468",
      "SMS_NOTIFY": ""
    }
  ],
  "totalRecords": 1
}
← Customer Header Record
Customer Master Record →