1 of 4

Manage lookup values

You can manage the lookup values in the following ways:

In this section, we will manage the lookup codes for the loan module.

You can only make these changes for the lookup codes that you create.

Mark lookup code as default

Use case

Here we will mark the value CREATED as default.

Use case data

API parameters with values

The first path parameter is the entity name (in this case, LOAN.LOAN_APPLICATION).

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

The third path parameter is the lookup code that we want to mark as default (in this case, CREATED).

Sample API call

To mark the lookup as default, use the following endpoint:

Sample response

Below you will find the response to the sample request:

Response

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

Result

The lookup code CREATED has been marked as default.

Remove default lookup code

Use case

We have created lookup codes for the status of loan applications: CREATED, ACCEPTED, and DECLINED. We have marked the value CREATED as default.

Here we will remove the default value from the list. Keep in mind that the lookup code is not removed, the default code is unmarked as default.

Use case data

API parameters with values

The first path parameter is the entity name (in this case, LOAN.LOAN_APPLICATION).

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

Sample API call

To remove the default value, use the following endpoint:

Sample response

Below you will find the response to the sample request:

Response

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

Result

The lookup code CREATED has been unmarked as the default value.

Delete lookup code

Use case

We have created lookup codes for the status of loan applications: CREATED, ACCEPTED, and DECLINED.

Here we will delete the value DECLINED from the list of lookup codes.

Use case data

API parameters with values

The first path parameter is the entity name (in this case, LOAN.LOAN_APPLICATION).

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

The third path parameter is the lookup code that you want to delete (in this case, DECLINED).

Sample API call

To delete the lookup code, use the following endpoint:

Sample response

Below you will find the response to the sample request:

Response

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

Result

The lookup code DECLINED has been deleted from the list of lookup values for the status of loan applications.

Mark lookup code as default

Use case

We have for the status of loan applications: CREATED, ACCEPTED, and DECLINED.

Here we will mark the value CREATED as default.

Use case data

API parameters with values

The first path parameter is the entity name (in this case, LOAN.LOAN_APPLICATION).

"...entity/LOAN.LOAN_APPLICATION..."

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

"...lookup-type/STATUS..."

The third path parameter is the lookup code that we want to mark as default (in this case, CREATED).

"...lookup/CREATED/...

Sample API call

To mark the lookup as default, use the following endpoint:

https://lookup-api.sandbox.tuumplatform.com/api/v1/entity/LOAN.LOAN_APPLICATION/lookup-type/STATUS/lookup/CREATED/mark-default

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": null
}

Result

The lookup code CREATED has been marked as default.

Delete lookup code

Use case

We have created lookup codes for the status of loan applications: CREATED, ACCEPTED, and DECLINED.

Here we will delete the value DECLINED from the list of lookup codes.

Use case data

API parameters with values

The first path parameter is the entity name (in this case, LOAN.LOAN_APPLICATION).

"...entity/LOAN.LOAN_APPLICATION..."

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

"...lookup-type/STATUS..."

The third path parameter is the lookup code that you want to delete (in this case, DECLINED).

"...lookup/DECLINED"

Sample API call

To delete the lookup code, use the following endpoint:

https://lookup-api.sandbox.tuumplatform.com/api/v1/entity/LOAN.LOAN_APPLICATION/lookup-type/STATUS/lookup/DECLINED

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": null
}

Result

The lookup code DECLINED has been deleted from the list of lookup values for the status of loan applications.

Remove default lookup code

Use case

We have created lookup codes for the status of loan applications: CREATED, ACCEPTED, and DECLINED. We have marked the value CREATED as default.

Here we will remove the default value from the list. Keep in mind that the lookup code is not removed, the default code is unmarked as default.

Use case data

API parameters with values

The first path parameter is the entity name (in this case, LOAN.LOAN_APPLICATION).

"...entity/LOAN.LOAN_APPLICATION..."

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

"...lookup-type/STATUS..."

Sample API call

To remove the default value, use the following endpoint:

https://lookup-api.sandbox.tuumplatform.com/api/v1/entity/LOAN.LOAN_APPLICATION/lookup-type/STATUS/remove-default

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": null
}

Result

The lookup code CREATED has been unmarked as the default value.