Find lookup type codes

Use case

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

Use case data	API parameters with values
The first query parameter is the group code (in this case, PERSON).	"...?groupCode=PERSON..."
The second query parameter is the entity name (in this case, PERSON.ADDRESS).	"...&entityName=PERSON.ADDRESS"

Note that the query parameters are not mandatory fields. If you do not enter any values, the complete list of lookup type codes will be returned, regardless of the lookup group or 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

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",
            "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.

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