List Currencies

GET /currencies
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/currencies

Returns a list of Currencies

query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,filed2
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string 'sou'.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string 'sou'

See tips for the list of searchable parameters.
idstring
Unique id of the currency. Example - CNY


Example: id=CNY
namestring
The name of the currency. Example - Euro


Example: name="Euro"
codestring
Three-letter, uppercase currency code. Example - CNY


Example: code=CNY
ratenumber
Currency exchange rate. Example - 6.3848


Example: rate=6.3848
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ currency ]
An array of all created items.
Currency
Name
Description
codestring
Three-letter, uppercase currency code.


Example: CNY
idstring
A unique identifier generated by the Ocamba platform.


Example: CNY
namestring
Currency name.


Example: Chinese Yuan Renminbi
ratefloat
An exchange rate.


Example: 6.3848
totalinteger
A total number of items.


Example: 8
tip
1 Searchable field is name.
2 Sortable fields are: name, code, rate and id.
3 Filterable fields are: name, code, rate and id.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 8,
    "items": [
        {
            "id": "CNY",
            "code": "CNY",
            "name": "Chinese Yuan Renminbi",
            "rate": 6.3848
        },
        {
            "id": "EUR",
            "code": "EUR",
            "name": "Euro",
            "rate": 0.88963
        },
        {
            "id": "ILS",
            "code": "ILS",
            "name": "Israeli Shekel",
            "rate": 3.09698
        }
    ]
}

{
  "total": 8,
  "items": [
    {
      "id": "CNY",
      "code": "CNY",
      "name": "Chinese Yuan Renminbi",
      "rate": 6.3848
    }
  ]
}