CRcrunchtime
Currency Ratio Service

getCurrencyRatioByPage

Changed on

Retrieve a single currency exchange rate by pageNumber.

get/currencyratio/v1/getCurrencyRatioByPage

Request

  • Base URL
    //webservices-test.net-chef.com (relative, and the document’s source URL is not known)
  • URL
    //webservices-test.net-chef.com/currencyratio/v1/getCurrencyRatioByPage
  • Auth
    none declared. Required headers: authenticationtoken, password, sitename, userid

Query parameters

fromCurrencyCodestring

The alternate currency code.

pageNumberinteger

Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.

pageSizeinteger

Number of items to display per page.

toCurrencyCodestring

The base currency code.

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

hasNextboolean
totalPagesinteger

Example response

{
  "currencyRatioDetails": [
    {
      "currencyRatioDetailDetails": [
        {
          "exchangeRate": 32.9,
          "fromCurrencyCode": "USD",
          "toCurrencyCode": "EUR"
        }
      ]
    }
  ]
}

Changes

  • fff247a87cc9Revision changes
    • breaking

      the response property //// became optional for the status (media type: */*)

    • breaking

      the response property //// became optional for the status (media type: application/json)

    • info

      the response property //// became required for the status (media type: */*)

    • info

      the response property //// became required for the status (media type: application/json)