Skip to main content

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
MethodGET
URL or Endpoint/api/currencies/select-list
HeadersAuthorization
ParametersNot Applicable
BodyNot 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 NameTypeDescription
successboolIf the response is successful, it will return true. Otherwise, it will return false.
errorsarray[string]Indicates if there was an error.
messagesarray[string]Returns the response message from the back-end.
resultarray[Object]Returns an array of objects with currency details.
idintegerUnique identifier of the currency.
namestringName of the currency.
valuestringCurrency code (e.g., USD, EUR, CZK).
descriptionstringDescription of the currency (null if not provided).
resultInfostringReturns extra information about the result.
statusCodeinteger($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