Find lookup type codes

Use case

Here we will find the existing lookup type codes under the PERSON.ADDRESS entity.

Sample API call

To find the lookup type codes, use the following endpoint:

https://lookup-api.sandbox.tuumplatform.com/api/v1/lookup-type?groupCode=PERSON&entityName=PERSON.ADDRESS

Sample response

Below you will find the response to the sample request:

{
    "errors": null,
    "validationErrors": null,
    "data": [
        {
            "entityName": "PERSON.ADDRESS",
            "lookupTypeCode": "PERSON_ADDRESS_TYPE",
            "lookupTypeName": "Person address type codes",
            "groupCode": "PERSON",
            "configurable": false
        },
        {
            "entityName": "PERSON.ADDRESS",
            "lookupTypeCode": "PERSON_LEGAL_ADDRESS_TYPE",
            "lookupTypeName": "Legal person address type codes",
            "groupCode": "PERSON",
            "configurable": false
        }
    ]
}

Result

We can see the list of lookup type codes for the PERSON.ADDRESS entity. The sample response shows that there are 2 types of addresses that are valid for a person - private and legal. Next, we will find the address lookup types for private persons.