Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

getExchangeRates

Synopsis

ExchangeRate[] getExchangeRates(SessionId sessionId,
    string[]    currencies,
    boolean?    active)
throws BasketServiceFault;

See also: ExchangeRate, SessionId, BasketServiceFault

With the operation getExchangeRates all or a subset of the currently defined exchange rates are accessible.

The argument currencies represents zero or more currency codes.

If no currency has been specified, the operation returns the exchange rates of all currencies known to the currency converter.

Argument active controls whether to return exchange rates used by the current basket (if true, the default value) or exchange rates of the server’s currency configuration as currently seen by the session (if false).

The active, i.e. current basket’s exchange rates may differ from the server’s exchange rates if the active exchange rates and/or reference currency have been changed, or if the server’s currency configuration as seen by the session changes, as may currently happen under certain implementation-dependent circumstances.

If at least one currency has been specified, the operation fails with a BasketServiceFault if at least one currency is not a valid ISO 4217 currency code (excluding pseudo currencies (all currency codes starting with ‘X’ except ‘XAF’, ‘XOF’, ‘XPF’ and ‘XCF’)). The exchange rates are returned in the same order as the currency codes, one instance of type ExchangeRate for each currency. If one of the currencies is not a known currency (not known to the currency converter), the attribute rate of the returned exchange rate is missing.