Phone Type Purpose Mapping Configurations

The admin entity holds the mapping between the PhoneType and PhonePurpose lookup code values. These mappings provide upgrade safety of existing data. The following phone type purpose mappings are delivered with the solution. Review the values you need for your implementation, which should be based on the phone type values configured in the Utility configuration PHONE_purpose section.

Customers can modify these values or can add new values as needed using the APIs noted below.

PhoneType PhonePurpose ID
WORK BUSINESS WORK
HOME HOME_BUSINESS HOME
MOBILE PERSONAL MOBILE

To view, edit, and add reference types, use the information in this table.

Person Data Configuration Comment
Add a phone type - phone purpose mapping. You can add multiple phone type -phone purpose mapping to the payload, as needed.

POST /CXIPlatformService/v1/CXIReferenceEntity/phoneTypePurposeMapping

Example:

{
    "items": [
        {
            "operation": "create",
            "data": {
                "id": "MOBILE",
                "phoneType": "MOBILE",
                "phonePurpose": "PERSONAL"
            }
        },
        {
            "operation": "create",
            "data": {
                "id": "WORK",
                "phoneType": "WORK",
                "phonePurpose": "BUSINESS"
            }
        },
        {
            "operation": "create",
            "data": {
                "id": "HOME",
                "phoneType": "HOME",
                "phonePurpose": "HOME_BUSINESS"
            }
        }
    ]
}
 Multiple records can be added together by adding them to the "items" list in the request.
Edit phone type - phone purpose mapping. POST /CXIPlatformService/v1/CXIReferenceEntity/phoneTypePurposeMapping

Example:

{
  "items": [
    {
      "operation": "update",
      "data": {
        "id": "MOBILE",
        "phoneType": "mob",
        "phonePurpose": "PERSONAL"
      }
    },
    {
      "operation": "update",
      "data": {
        "id": "WORK",
        "phoneType": "business",
        "phonePurpose": "BUSINESS"
      }
    }
  ]
}
 Multiple records can be edited at the same time by adding them to the "items" list in the request.
Fetch phone type - phone purpose mapping. GET /utilitiesAdmin/v1/phoneTypePurposeMapping

Example:

{
    "offset": 0,
    "limit": 25,
    "count": 3,
    "hasMore": false,
    "items": [
        {
            "phoneType": "WORK",
            "id": "WORK",
            "phonePurpose": "BUSINESS"
        },
        {
            "phoneType": "HOME",
            "id": "HOME",
            "phonePurpose": "HOME_BUSINESS"
        },
        {
            "phoneType": "MOBILE",
            "id": "MOBILE",
            "phonePurpose": "PERSONAL"
        }
    ]
}
  
Fetch phone type - phone purpose mapping by id. A specific identifier type can be fetched as well.

GET /utilitiesAdmin/v1/phoneTypePurposeMapping/WORK

Example:

{
    "phoneType": "WORK",
    "id": "WORK",
    "phonePurpose": "BUSINESS"
}
  

Parent topic: View and Edit the Existing Configuration