The OANDA operation defines how to interact with the OANDA API.
You must create a separate operation component for each action that your integration requires.
The OANDA connector operation support the Inbound: Query action.
The OANDA connector supports the Query action. Use the Import Wizard to select the action to take with OANDA. The following table describes the default field definitions for each action type:
|Object||An object defines what you want to integrate or the action to execute, which you select in the Import Wizard.|
|Response Profile||The XML profile definition that represents the structure that is being received by the connector.|
|Return Application Error Responses||This setting controls whether an application error
prevents an operation from completing:|
|data set (optional)||An optional field that allows you to configure which data set to query against. This field only applies to the Currencies and Rates action.|
OANDA operation actions
You configure the OANDA operation to retrieve document records with the OANDA API. For all inbound operations, unique parameters are required at runtime to request the data. Review this information and understand how to statically or dynamically define these values in a process.
Depending on the action selected, the Query action may or may not require static or dynamic request parameters (filters) to control the document that will be queried from OANDA. Each Query request returns a single document.
The following objects are supported:
|Currencies||Returns all the supported currencies under the specified data set. If no data set value is provided, the API uses the OANDA data set. For more information, see the Specifications & Caveats section in the OANDA developer documentation.|
|Remaining Quotes||Returns the remaining Quotes limit for the specific connection API Key.|
|Rates||Returns the Currency Exchange Rate with the specified parameters.|
|Rate (XXX)||Returns the Currency Exchange Rate for a specific base currency. For example, Rate (USD) returns the Currency Exchange Rate with United States Dollar (USD) as the base currency.|
NOTE: When importing, this object type is only accessible by enabling the Generate Supported Currency option.
After using the Import Wizard, select the fields and add query filters if necessary, as shown in the following image.
In the previous image:
- Field selection. Determines the field that is returned from the OANDA API response.NOTE: This functionality is subject to availability. For more information, see the Input Query Parameters section in the OANDA API documentation.
- Filter setup. You can set up the parameters that are required for the specific object.
Depending on the object selected and the information required, you may need to set up some filters. The filter for the Rates and Rate (XXX) objects include the following:
- data_set. Represents the data set to query. Overrides the operation level. For more information, see the linked OANDA data set topic.
- base_currency. Represents the base currency that the Rates call will use. This filter is not available in Rate (XXX).
For more information about each filter and their corresponding and expected value, see the Input Query Parameters section in the OANDA documentation.
The filter for the Remaining Quotes object includes the following:
- proceed_without_remaining_quote. Set to "false" or "true" by the user. Allows the process to either halt or continue with an error with the Remaining Quotes, assuming that Return Application Error Responses is selected.
The filter for the Currencies object includes the following:
- data_set. Represents the data set to query; overrides the operation level. For more information, see the linked OANDA data set topic.
The following image illustrates a sample filter for Rates with several quotes and dates.
The following image illustrates the corresponding value for each filter.
Data returned by Query actions
Querying Currencies, Rates, and Remaining Success returns a document, as shown in the following example.
<response> <currencies> <currency> <code>AUD</code> <description>Australian Dollar</description> </currency> <currency> <code>BGN</code> <description>Bulgarian Lev</description> </currency> </currencies> </response>
If the Return Application Error Responses check box is on, errors are returned from all objects. The following is an example of an error response for the Remaining Quotes operation.
<response> <code>53</code> <message>Rate limit violation.</message> </response>
See the Connector operation’s Archiving tab for more information.
See the Connector operation’s Tracking tab for more information.
See the Connector operation’s Caching tab for more information.