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.
The first path parameter is the entity name (in this case, PERSON.ADDRESS).
The second path parameter is the lookup type code (in this case, PERSON_ADDRESS_TYPE)
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
Below you will find the response to the sample request:
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.
".../PERSON.ADDRESS/lookup/..."
".../PERSON_ADDRESS_TYPE"
{
"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
}
]
}
According to the lookup groups available in your Tuum configuration, you can find the existing lookup values.
In this section, you will learn how to find the enum values associated with the person module.
First, we will find the entities associated with the person group.
We will find the lookup type codes for a particular entity.
Then we will find the list of lookup types for a particular lookup type code.
Finally, we will see how to find the translation for a specific lookup type.
Here we will find the translation for a particular address lookup type.
The first path parameter is the entity name (in this case, PERSON.ADDRESS).
The second path parameter is the lookup type code (in this case, PERSON_ADDRESS_TYPE).
The third parameter is the lookup type for which we want to find the translation (in this case, C).
The query parameter is the language code.
To find the translation, use the following endpoint:
https://lookup-api.sandbox.tuumplatform.com/api/v1/entity/PERSON.ADDRESS/lookup-type/PERSON_ADDRESS_TYPE/lookup/C/translation?languageCode=en
Below you will find the response to the sample request:
We can see the translation for the address type C with this endpoint.
".../PERSON.ADDRESS/lookup-type/..."
".../PERSON_ADDRESS_TYPE/lookup/..."
".../C/translation..."
"...translation?languageCode=en"
Here we will find the entities associated with the PERSON group.
The query parameter is the group code (in this case, PERSON).
To find the entities, use the following endpoint:
https://lookup-api.sandbox.tuumplatform.com/api/v1/entity?groupCode=PERSON
Below you will find the response to the sample request:
We can see the list of entity names for the person module. Next, we will find the lookup types associated with the entity PERSON.ADDRESS.
".../entity?groupCode=PERSON"
Here we will find the existing lookup type codes under the PERSON.ADDRESS entity.
The first query parameter is the group code (in this case, PERSON).
The second query parameter is the entity name (in this case, PERSON.ADDRESS).
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
Below you will find the response to the sample request:
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.
"...?groupCode=PERSON..."
"...&entityName=PERSON.ADDRESS"