Retrieving all currencies
GET {{api-url}}/currency/{{tenant}}/currencies?pageNumber=1&pageSize=16
Retrieves all currencies. There is a possibility to filter by the base currency params like code and name.
* If the Accept-Language is set to * each internationalized field should be provided as a map that contains all of translations in a format of key:value pairs, where the key is the language code and value is the translation.
* If the Accept-Language contains a single language then the translation should be passed as a string value.
* If the Accept-Language header is empty default language defined in the Configuration service is taken.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
sort | string | Fields to sort the response data by following order of the parameters from left to right. Can contain multiple fields in format: field name:sort direction separated by a comma. The colon with sort direction parameter is redundant and descending order is taken only if it is equal to desc or DESC. Ascending order is considered in any other case. Sorting by name parameter works properly only if the Accept-Language header is set to a specific language or is empty with default language specified in the configuration service. | |
code | string | Returns all currencies which contains the value. For example, for filter value: code=BD the following currencies might be returned: BBD, BDT, SBD, XBD | |
name | string | Filtering by localized fields without language key is possible only when Accept-Language header with correct language is provided or when it is not set at all (in that case default language is taken) For example when Accept-Language is set to en and the name parameter is equal to name=Doll then Dollar should be returned. When Accept-Language header is set to * filtering by localized fields is possible only when fields contains language key. For example when Accept-Language is set to * and name parameter is equal to name.en=Doll then Dollar should be returned.
| |
pageNumber | number | ||
pageSize | number |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept-Language | string | The Accept-Language request HTTP header defines which languages the client is able to understand, and which locale variant is preferred. If empty then default system language is returned. It can be a priority list working as a fallback mechanism. | |
X-Total-Count | boolean | The flag indicates if the total count of items should be returned. The total count will be returned as a value of X-Total-Count header | |
Accept | string |
RESPONSES
status: OK
[{"code":"USD","name":"Dollar"},{"code":"EUR","name":"Euro"}]