GET Currencies as Select List
Overview
The following table contains information about the GET
method for managing the proccess of retrieving all currencies as a list.
GET Currencies as select list | |
---|---|
Method | GET |
URL or Endpoint | /api/currencies/select-list |
Headers | Authorization |
Parameters | Not Applicable |
Body | Not Applicable |
Request Body
The GET
method doesn't contain a request body.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": 1,
"name": "USD",
"value": "USD",
"description": null
},
{
"id": 2,
"name": "EUR",
"value": "EUR",
"description": null
},
{
"id": 3,
"name": "CZK",
"value": "CZK",
"description": null
}
],
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
Field Name | Type | Description |
---|---|---|
success | bool | If the response is successful, it will return true. Otherwise, it will return false. |
errors | array[string] | Indicates if there was an error. |
messages | array[string] | Returns the response message from the back-end. |
result | array[Object] | Returns an array of objects with currency details. |
id | integer | Unique identifier of the currency. |
name | string | Name of the currency. |
value | string | Currency code (e.g., USD, EUR, CZK). |
description | string | Description of the currency (null if not provided). |
resultInfo | string | Returns extra information about the result. |
statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed