1 of 5

Find lookup values

According to the lookup groups available in your Tuum configuration, you can find the existing lookup values.

Use case

In this section, you will learn how to find the enum values associated with the person module.

Similarly, you can find the values for other modules.

Find entities

Use case

Here we will find the entities associated with the PERSON group.

Use case data

API parameters with values

The query parameter is the group code (in this case, PERSON).

Sample API call

To find the entities, use the following endpoint:

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": [
    "PERSON.ADDRESS",
    "PERSON.DOCUMENT",
    "PERSON.EXTERNAL_CONTRACTS",
    "PERSON.FINANCIAL_DATA",
    "PERSON.PERSON",
    "PERSON.PERSON_RELATIONSHIP"
  ]
}

Result

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.

You cannot edit the entities that are available in the system.

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).

The second query parameter is the entity name (in this case, 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:

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.

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).

The second path parameter is the lookup type code (in this case, PERSON_ADDRESS_TYPE)

Sample API call

To find the lookup types, use the following endpoint:

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.

Find translation of lookup type

Use case

Here we will find the translation for a particular address lookup type.

Use case data

API parameters with values

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.

Sample API call

To find the translation, use the following endpoint:

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": "Correspondence address"
}

Result

We can see the translation for the address type C with this endpoint.

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 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

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

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 f 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

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

Find translation of lookup type

Use case

Here we will find the translation for a particular address lookup type.

Use case data

API parameters with values

The first path parameter is the entity name (in this case, PERSON.ADDRESS).

".../PERSON.ADDRESS/lookup-type/..."

The second path parameter is the lookup type code (in this case, PERSON_ADDRESS_TYPE).

".../PERSON_ADDRESS_TYPE/lookup/..."

The third parameter is the lookup type for which we want to find the translation (in this case, C).

".../C/translation..."

The query parameter is the language code.

"...translation?languageCode=en"

Sample API call

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

Learn more about the endpoint in the Tuum developer portal.

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": "Correspondence address"
}

Result

We can see the translation for the address type C with this endpoint.

Find entities

Use case

Here we will find the entities associated with the PERSON group.

Use case data

API parameters with values

The query parameter is the group code (in this case, PERSON).

".../entity?groupCode=PERSON"

Sample API call

To find the entities, use the following endpoint:

https://lookup-api.sandbox.tuumplatform.com/api/v1/entity?groupCode=PERSON

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": [
    "PERSON.ADDRESS",
    "PERSON.DOCUMENT",
    "PERSON.EXTERNAL_CONTRACTS",
    "PERSON.FINANCIAL_DATA",
    "PERSON.PERSON",
    "PERSON.PERSON_RELATIONSHIP"
  ]
}

Result

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.

You cannot edit the entities that are available in the system.