Endpoint reference (detailed)
All request and response bodies are JSON unless otherwise stated. For each endpoint below you'll find:
- API path
- Short one-line description
- Positive and negative cases for: Request type, Request body, Response body, Status code
Before a user can search or filter loan applications in the dashboard, the frontend application calls this endpoint to populate the filter menus. It returns the pre-defined reference options for loan status flags and submission years.
Dropdown options
- URL:
/dropdown/filters - Method:
GET - Description: This API will returns the loan application status and application year dropdown options that is available in the search filter. Positive case returns 200 OK.
DROPDOWN API – SCHEMAS
Model: Dropdown Response
| Field | Type | Description |
|---|---|---|
| loanStatus | array |
List of Loan application status |
| applicationYear | array |
List of application year |
Dropdown Response
loanStatus: `array<LoanStatus>`
applications: `array<ApplicationYear>`
Example
Response:
{
"loanStatus": ["Approved", "Pending", "Rejected"],
"applicationYear": ["2023", "2024", "2025"]
}
