Find lookup types

Use case

Here we will find the lookup types under the PERSON.ADDRESS entity and the PERSON_ADDRESS_TYPE lookup type code. This lookup type code refers to the address types valid for private persons.

Use case data	API parameters with values
The first path parameter is the entity name (in this case, PERSON.ADDRESS).	".../PERSON.ADDRESS/lookup/..."
The second path parameter is the lookup type code (in this case, PERSON_ADDRESS_TYPE)	".../PERSON_ADDRESS_TYPE"

Sample API call

To find the lookup types, use the following endpoint:

https://lookup-api.sandbox.tuumplatform.com/api/v1/entity/PERSON.ADDRESS/lookup-type/PERSON_ADDRESS_TYPE/lookup-settings

Learn more about the find lookup types endpoint in the Tuum developer portal.

Sample response

Below you will find the response to the sample request:

Response

{
    "errors": null,
    "validationErrors": null,
    "data": [
        {
            "entityName": "PERSON.ADDRESS",
            "lookupTypeCode": "PERSON_ADDRESS_TYPE",
            "lookupCode": "B",
            "defaultValue": false
        },
        {
            "entityName": "PERSON.ADDRESS",
            "lookupTypeCode": "PERSON_ADDRESS_TYPE",
            "lookupCode": "BILLING",
            "defaultValue": false
        },
        {
            "entityName": "PERSON.ADDRESS",
            "lookupTypeCode": "PERSON_ADDRESS_TYPE",
            "lookupCode": "C",
            "defaultValue": false
        },
        {
            "entityName": "PERSON.ADDRESS",
            "lookupTypeCode": "PERSON_ADDRESS_TYPE",
            "lookupCode": "R",
            "defaultValue": false
        }
    ]
}

Result

We can see the list of address lookup types for private persons. This means that a person's address type must be one of the defined values. Next, we will find the translation for a particular lookup type.

You can also get similar responses using the module-specific API endpoint. For example, you can use this endpoint: person-api.sandbox.tuumplatform.com /api/v1/entity/PERSON.ADDRESS/lookup/PERSON_ADDRESS_TYPE