Search Capabilities
The Savings Pot Microservice provides a set of APIs that allows the customers to retrieve and search Savings Pot details based on certain predefined criteria(s). The response details and the response time for these APIs will vary from one category to another. Following are the Retrieve API and Search API.
Retrieve API
The Retrieve APIs narrow down to a unique Savings Pot type or very small set of Savings Pot.
GetAllSavingsPot/savingsPotId
Query Options
| Retrieve Criteria | Query Parameter | Operator |
|---|---|---|
| Savings Pot Id | SavingsPotId | Equals |
Query Option Rules
Savings Pot Id :
Savings Pot ID must be supplied. It gives the Savings Pot details for a particular ID.
Refer to Swagger documentation for the Payload details of the API.
Search API
The search APIs potentially narrow down to a larger set of Savings Pot, depending on the criteria and the distribution of the various Savings Pot data (Pot Type, Pot Status, and so on.)
GetAllSavingsPot
Query Options
| Search Criteria | Query By | Operator |
|---|---|---|
| Type of Savings Pot | potType |
Equals |
| Status of Savings Pot | status |
Equals |
| Funding Account ID | fundingAccountHoldingsId |
Equals |
Query Option Rules
- The potType is be given as search criteria.
- The Status of Savings Pot can also be provided as the search criteria, it lists all the Savings Pots where status is provided.
- Funding Account ID is another parameter that can be used as search criteria.
- If no search criteria is provided all the Savings Pots details will be listed.
Refer to Swagger documentation for the Payload details of the API.
In this topic