Foreign Exchange Rates Version 3.0.0

Foreign Exchange Rates Version 3.0.0 WSDL: http://ws.strikeiron.com/ForeignExchangeRate3?WSDL Product Web Page: http://www.strikeiron.com/Catalog/Prod...
8 downloads 4 Views 296KB Size
Foreign Exchange Rates Version 3.0.0 WSDL: http://ws.strikeiron.com/ForeignExchangeRate3?WSDL Product Web Page: http://www.strikeiron.com/Catalog/ProductDetail.aspx?pv=3.0.0&pn=Foreign+Exchange+Rates Description: The Foreign Exchange Rates Web Service provides both current (updated every 30minutes) and historical foreign exchange rates based on the London Close (11:30am EST) for 160 currencies. Rates are quoted either in U.S. dollars per foreign currency unit or in foreign currency units per U.S. dollar. Required License Information: The LicenseInfo parameter in our Web services provides the authentication credentials that allow you to invoke the Web service. If you are registered with StrikeIron, use the UserID and Password associated with your StrikeIron account in the UserID and Password fields. Alternatively, you can also use your license key obtained from your StrikeIron Account (leave the password blank). LicenseInfo Field: RegisteredUser Input UserID: Password:

Sample Input [email protected] Password1

License Subscription Information Output LicenseStatusCode: This field returns a numeric code indicating the StrikeIron license action taken as a result of invoking this operation from the User ID and Password used for input. Valid license codes are 0, 1, and 2. For example, a valid User ID and Password returns the code 0 with a corresponding LicenseStatus value of Valid license key.

Sample Output 0

LicenseStatus: This field returns the status of the StrikeIron User ID and Password corresponding to the LicenseStatusCode.

Valid license key

LicenseActionCode: This field returns a numeric code indicating the StrikeIron license action taken as a result of invoking this operation. GetRemainingHits returns the code 5 with a corresponding LicenseAction value of Get remaining hits.

0

LicenseAction: This field returns the license action taken as a result of invoking this operation from the User ID and Password used corresponding to the LicenseActionCode.

Decremented hit count

RemainingHits: This field returns the number of hits against the StrikeIron license key used when invoking this operation.

2

Amount: This field returns the number of hits used from the StrikeIron User ID provided to invoke this operation.

0

Foreign Exchange Rates v.3.0.0

page 1

Service Response Information Output ResponseCode: This field returns a numeric code that indicates the status of the request. If the request is successful, the response code is set to 0.

Sample Output 0

Response: This field returns the response status (successful or not) and identifies what kind of errors it encounters, corresponding to ResponseCode. Returned values can be Success or Failure. If the address entered as input is not found, or the input yields an output that is unsuccessful, then the Response is Failure.

Success

Available Operations: • GetLatestRate • GetLatestRates • CurrencyRateForAmount • GetHistoricalRates • GetHistoricalRate • GetAllLatestRatesToUSD • GetAllLatestUSDToCurrencies • GetSupportedCurrencies • GetStatusCodesForMethod • GetStatusCodes • GetServiceInfo • GetRemainingHits Operation: GetLatestRate Input SingleCurrencyFrom: Type the three-letter currency codes, separated by commas, for the currencies you want to convert. The currency codes can be found by invoking this Web service's GetSupportedCurrencies operation.

Sample Input EUR

SingleCurrencyTo: Type the three 3-letter currency code for the currency to which you want to convert.

USD

Operation: GetLatestRate Output Value: This field returns the exchange rate of the starting currency to the ending currency.

Sample Output 1.32665

Currency: This field returns the starting currency.

EUR

PerCurrency: This field returns the requested currency.

USD

Date: This field returns the date of the exchange rate.

4/27/2009 1:34:49 PM

Operation: GetLatestRate Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes)

Sample Output 212

StatusDescription: This field returns the description of the status number. (See GetStatusCodes)

Currency rate information Found

Foreign Exchange Rates v.3.0.0

page 2

Operation: GetLatestRates Input CommaSeparatedListOfCurrenciesFrom: Type the three-letter currency codes, separated by commas, for the currencies you want to convert. The currency codes can be found by invoking this Web service's GetSupportedCurrencies operation.

Sample Input EUR

SingleCurrencyTo: Type the three 3-letter currency code for the currency to which you want to convert.

USD

Operation: GetLatestRate Output Value: This field returns the exchange rate of the starting currency to the ending currency.

Sample Output 1.32665

Currency: This field returns the starting currency.

EUR

PerCurrency: This field returns the requested currency.

USD

Date: This field returns the date of the exchange rate.

4/27/2009 1:34:49 PM

Operation: GetLatestRate Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes)

Sample Output 212

StatusDescription: This field returns the description of the status number. (See GetStatusCodes)

Currency rate information Found

Operation: CurrencyRateForAmount Input SingleCurrencyFrom: Type the three-letter currency codes, separated by commas, for the currencies you want to convert. The currency codes can be found by invoking this Web service's GetSupportedCurrencies operation.

Sample Input EUR

SingleCurrencyTo: Type the three 3-letter currency code for the currency to which you want to convert.

USD

Amount: Currency amount you wish to convert.

200

Operation: CurrencyRateForAmount Output Value: This field returns the exchange rate of the starting currency to the ending currency.

Sample Output 265.33000000000004

Currency: This field returns the starting currency.

EUR

PerCurrency: This field returns the requested currency.

USD

Date: This field returns the date of the exchange rate.

4/27/2009 1:34:49 PM

Operation: CurrencyRateForAmount Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes)

Sample Output 212

Foreign Exchange Rates v.3.0.0

page 3

StatusDescription: This field returns the description of the status number. (See GetStatusCodes)

Currency rate information Found

Operation: GetHistoricalRates Input CommaSeparatedListOfCurriencesFrom: Type the three-letter currency codes, separated by commas, for the currencies you want to convert. The currency codes can be found by invoking this Web service's GetSupportedCurrencies operation.

Sample Input EUR

SingleCurrencyTo: Type the three 3-letter currency code for the currency to which you want to convert.

USD

Date: Historic date that you wish to lookup. Rate will be returned on the London close amount.

04/27/2009

Operation: GetHistoricalRates Output Value: This field returns the exchange rate of the starting currency to the ending currency based on the London close.

Sample Output 1.32665

Currency: This field returns the starting currency.

EUR

PerCurrency: This field returns the requested currency.

USD

Date: This field returns the date of the exchange rate.

4/27/2009 11:30:00 AM

Operation: GetHistoricalRates Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes)

Sample Output 212

StatusDescription: This field returns the description of the status number. (See GetStatusCodes)

Currency rate information Found

Operation: GetHistoricalRate Input SingleCurrencyFrom: Type the 3-letter currency code for the currency you want to convert.

Sample Input EUR

SingleCurrencyTo: Type the three 3-letter currency code for the currency to which you want to convert.

USD

DateFrom: Type the starting date in MM/D/YYYY format for your desired currency rate.

4/27/2009

DateTo: Type the ending date in MM/D/YYYY format for your desired currency rate.

4/29/2009

Operation: GetHistoricalRate Output Value: This field returns the exchange rate of the starting currency to the ending currency for that specified date.

Sample Output 1.31285

Currency: This field returns the starting currency.

EUR

PerCurrency: This field returns the requested currency.

USD

Foreign Exchange Rates v.3.0.0

page 4

Operation: GetHistoricalRate Output Date: This field returns the date of the exchange rate.

Sample Output 4/27/2009 11:30:00 AM

Value: This field returns the exchange rate of the starting currency to the ending currency for that specified date.

1.30765

Currency: This field returns the starting currency.

EUR

PerCurrency: This field returns the requested currency.

USD

Date: This field returns the date of the exchange rate.

4/28/2009 11:30:00 AM

Value: This field returns the exchange rate of the starting currency to the ending currency for that specified date.

1.32665

Currency: This field returns the starting currency.

EUR

PerCurrency: This field returns the requested currency.

USD

Date: This field returns the date of the exchange rate.

4/29/2009 11:30:00 AM

Operation: GetHistoricalRate Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes)

Sample Output 212

StatusDescription: This field returns the description of the status number. (See GetStatusCodes)

Currency rate information Found

Operation: GetAllLatestRatestoUSD Input Note: The only input needed for this operation is the LicenseInfo data. This operation calculates exchange rates from all related currencies into US dollars.

Sample Input n/a

Operation: GetAllLatestRatesToUSD Output Value: This field returns the exchange rate of the starting currency to the ending currency for that specified currency.

Sample Output (Partial List) 0.27223

Currency: This field returns the starting currency.

AED

PerCurrency: This field returns the requested currency.

USD

Date: This field returns the date of the exchange rate.

4/27/2009 1:34:49 PM

Value: This field returns the exchange rate of the starting currency to the ending currency for that specified currency.

0.72345

Currency: This field returns the starting currency.

AUD

PerCurrency: This field returns the requested currency.

USD

Date: This field returns the date of the exchange rate.

4/27/2009 1:34:49 PM

Value: This field returns the exchange rate of the starting currency to the ending currency for that specified currency.

0.1384

Foreign Exchange Rates v.3.0.0

page 5

Operation: GetAllLatestRatesToUSD Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes)

Sample Output 212

StatusDescription: This field returns the description of the status number. (See GetStatusCodes)

Currency rate information Found

Operation: GetAllLatestUSDtoCurrencies Input Note: The only input needed for this operation is the LicenseInfo data. This operation calculates exchange rates from US dollars into all related currencies.

Sample Input n/a

Operation: GetAllLatestUSDtoCurrencies Output Value: This field returns the exchange rate of the starting currency to the ending currency for that specified date.

Sample Output (Partial List) 3.672959671

Currency: This field returns the starting currency.

USD

PerCurrency: This field returns the requested currency.

AED

Date: This field returns the date of the exchange rate.

4/27/2009 1:34:49 PM

Value: This field returns the exchange rate of the starting currency to the ending currency for that specified date.

1.37523207

Currency: This field returns the starting currency.

USD

PerCurrency: This field returns the requested currency.

AUD

Date: This field returns the date of the exchange rate.

4/27/2009 1:34:49 PM

Value: This field returns the exchange rate of the starting currency to the ending currency for that specified date.

7.072135785

Currency: This field returns the starting currency.

USD

PerCurrency: This field returns the requested currency.

BWP

Date: This field returns the date of the exchange rate.

4/27/2009 1:34:49 PM

Value: This field returns the exchange rate of the starting currency to the ending currency for that specified date.

1.189697222

Currency: This field returns the starting currency.

USD

PerCurrency: This field returns the requested currency.

CAD

Date: This field returns the date of the exchange rate.

4/27/2009 1:34:49 PM

Operation: GetAllLatestUSDToCurrencies Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes)

Sample Output

Foreign Exchange Rates v.3.0.0

212

page 6

StatusDescription: This field returns the description of the status number. (See GetStatusCodes)

Currency rate information Found

Operation: GetSupportedCurrencies Input Note: The only input needed for this operation is the LicenseInfo data. This operation displays the name of a country's currency and the currency codes from the list of countries.

Sample Input n/a

Operation: GetSupportedCurrencies Output Unit: This field returns the 3-letter indicator of the currency.

Sample Output (See list below) AED

Country: This field returns the country name.

UAE

Supported Currency List Unit Country AED

UAE

AFN

AFGHANISTAN

ALL

ALBANIA

AMD

ARMENIA

ANG

NETH ANTILLES

AOA

ANGOLA

ARS

ARGENTINA

AUD

AUSTRALIA

AWG

ARUBA

AZN

AZERBAIJAN

BAM

BOSNIA&HERZEGOVIN

BBD

BARBADOS

BDT

BANGLADESH

BGN

BULGARIA

BHD

BAHRAIN

BIF

BURUNDI

BMD

BERMUDA

BND

BRUNEI DARUSSALAM

BOB

BOLIVIA

BRL

BRAZIL

BSD

BAHAMAS

BTN

BHUTAN

BWP

BOTSWANA

BYR

BELARUS

BZD

BELIZE

CAD

CANADA

CDF

CONGO(DEM REP)

CHF

SWITZERLAND

CLP

CHILE

CNY

CHINA

Foreign Exchange Rates v.3.0.0

page 7

COP

COLOMBIA

CRC

COSTA RICA

CUP

CUBA

CVE

CAPE VERDE

CZK

CZECH REPUBLIC

DJF

DJIBOUTI

DKK

DENMARK

DOP

DOMINICAN REP

DZD

ALGERIA

EEK

ESTONIA

EGP

EGYPT

ERN

ERITREA

ETB

ETHIOPIA

EUR

EUR

FJD

FIJI

FKP

FALKLAND ISLANDS

GBP

UNITED KINGDOM

GEL

GEORGIA

GHS

GHANA

GIP

GIBRALTAR

GMD

GAMBIA

GNF

GUINEA

GTQ

GUATEMALA

GYD

GUYANA

HKD

HONG KONG

HNL

HONDURAS

HRK

CROATIA

HTG

HAITI

HUF

HUNGARY

IDR

INDONESIA

ILS

ISRAEL

INR

INDIA

IQD

IRAQ

IRR

IRAN

ISK

ICELAND

JMD

JAMAICA

JOD

JORDAN

JPY

JAPAN

KES

KENYA

KGS

KYRGYZSTAN

KHR

CAMBODIA

KMF

COMOROS

KPW

KOREA(DEM REP)

KRW

KOREA

KWD

KUWAIT

Foreign Exchange Rates v.3.0.0

page 8

KYD

CAYMAN ISLANDS

KZT

KAZAKSTAN

LAK

LAOS

LBP

LEBANON

LKR

SRI LANKA

LRD

LIBERIA

LSL

LESOTHO

LTL

LITHUANIA

LVL

LATVIA

LYD

LIBYA

MAD

MOROCCO

MDL

MOLDOVA

MGA

MADAGASCAR

MKD

MACEDONIA

MMK

MYANMAR BURMA

MNT

MONGOLIA

MOP

MACAU

MRO

MAURITANIA

MUR

MAURITIUS

MVR

MALDIVES

MWK

MALAWI

MXN

MEXICO

MYR

MALAYSIA

MZN

MOZAMBIQUE

NAD

NAMIBIA

NGN

NIGERIA

NIO

NICARAGUA

NOK

NORWAY

NPR

NEPAL

NZD

NEW ZEALAND

OMR

OMAN

PAB

PANAMA

PEN

PERU

PGK

PAPUA NEW GUINEA

PHP

PHILIPPINES

PKR

PAKISTAN

PLN

POLAND

PYG

PARAGUAY

QAR

QATAR

RON

ROMANIA

RSD

SERBIA&MONTENEGRO

RUB

RUSSIA

RWF

RWANDA

SAR

SAUDI ARABIA

SBD

SOLOMON ISLANDS

Foreign Exchange Rates v.3.0.0

page 9

SCR

SEYCHELLES

SDG

SUDAN

SEK

SWEDEN

SGD

SINGAPORE

SHP

ST HELENA

SLL

SIERRA LEONE

SOS

SOMALIA

SRD

SURINAME

STD

SAO TOME

SVC

EL SALVADOR

SYP

SYRIAN ARAB REP

SZL

SWAZILAND

THB

THAILAND

TJS

TAJIKISTAN

TMT

TURKMENISTAN

TND

TUNISIA

TOP

TONGA

TRY

TURKEY

TTD

TRINIDAD&TOBAGO

TWD

TAIWAN

TZS

TANZANIA

UAH

UKRAINE

UGX

UGANDA

USD

UNITED STATES

UYU

URUGUAY

UZS

UZBEKISTAN

VEF

VENEZUELA

VND

VIETNAM

VUV

VANUATU

WST

SAMOA

XAF

CENTRAL AFR REPS

XCD

EAST CARRIBEAN

XDR

UNITED KINGDOM

XOF

CENTRAL AFR REPS

XPF

FRENCH POLYNESIA

YER

YEMEN

ZAR

SOUTH AFRICA

ZMK

ZAMBIA

ZWD

ZIMBABWE

Operation: GetSupportedCurrencies Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes)

Foreign Exchange Rates v.3.0.0

Sample Output 210

page 10

StatusDescription: This field returns the description of the status number. (See GetStatusCodes)

Currency Information Found

Operation: GetStatusCodesForMethod Input *MethodName: Input a method name to obtain a list of the Status Codes for that method that display in the StatusNbr and StatusDescription fields. Input options are: GetLatestRate, GetLatestRates, CurrencyRateForAmount, GetHistoricalRates, GetHistoricalRate, GetAllLatestRatesToUSD, GetAllLatestUSDToCurrencies, GetSupportedCurrencies, GetStatusCodesForMethod, GetStatusCodes, GetServiceInfo, GetRemaininigHits. Required.

Sample Input GetLatestRate

Operation: GetStatusCodesForMethod Output (ServiceResult)

Sample Output

StatusNbr 212 311 401 500

StatusDescription Currency rate information Found Currency rate information Not Found Currency code is not in the list Internal Error

Operation: GetStatusCodesForMethod Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes)

Sample Output 200

StatusDescription: This field returns the description of the status number. (See GetStatusCodes)

Found

Operation: GetStatusCodes Input Note: The only input needed for this operation is the LicenseInfo data. This operation displays a list of the Status Codes for the Web service that display in the StatusNbr and StatusDescription fields.

Sample Input (No input required)

Operation: GetStatusCodes Output (MethodStatusRecord) MethodName: GetLatestRate

Sample Output

StatusNbr 212 311 401 500

StatusDescription Currency rate information Found Currency rate information Not Found Currency code is not in the list Internal Error

MethodName: GetLatestRates StatusNbr 212 213 311 401 402

StatusDescription Currency rate information Found Currency rate information Found, but one or more were Not Found Currency rate information Not Found Currency code is not in the list Currency list is empty or contains invalid characters

Foreign Exchange Rates v.3.0.0

page 11

500

Internal Error

MethodName: CurrencyRateForAmount StatusNbr 212 311 401 500

StatusDescription Currency rate information Found Currency rate information Not Found Currency code is not in the list Internal Error

MethodName: GetHistoricalRates StatusNbr 212 311 312 401 402 403 404 500

StatusDescription Currency rate information Found Currency rate information Not Found Currency rate information Not Found for this date it might be a weekend or a holiday Currency code is not in the list Currency list is empty or contains invalid characters Invalid date format Date is outside of available range Internal Error

MethodName: GetHistoricalRate StatusNbr 212 311 312 401 404 405 500

StatusDescription Currency rate information Found Currency rate information Not Found Currency rate information Not Found for this date it might be a weekend or a holiday Currency code is not in the list Date is outside of available range Date range is greater than one year Internal Error

MethodName: GetAllLatestRatesToUSD StatusNbr 212 311 500

StatusDescription Currency rate information Found Currency rate information Not Found Internal Error

MethodName: GetAllLatestUSDToCurrencies StatusNbr 212 311 500

StatusDescription Currency rate information Found Currency rate information Not Found Internal Error

MethodName: GetSupportedCurrencies

Foreign Exchange Rates v.3.0.0

page 12

StatusNbr 210 311 500

StatusDescription Currency information Found Currency rate information Not Found Internal Error

MethodName: GetStatusCodesForMethod StatusNbr 200 300 400 500

StatusDescription Found Not Found Invalid Method Name Internal Error

MethodName: GetStatusCodes StatusNbr 200 300 500

StatusDescription Found Not Found Internal Error

MethodName: GetServiceInfo StatusNbr 200 300 500

StatusDescription Found Not Found Internal Error

Operation: GetStatusCodes Output (ServiceStatus) StatusNbr: This field returns a number referring to the status of this request. (See GetStatusCodes)

Sample Output 200

StatusDescription: This field returns the description of the status number. (See GetStatusCodes)

Found

Operation: GetServiceInfo Input Note: The only input needed for this operation is the LicenseInfo data. This operation displays the last time the Web service source data was updated.

Sample Input (No input required)

Operation: GetServiceInfo Output (ServiceInfoRecord) InfoKey: (For future development)

Sample Output (none)

InfoValue: (For future development)

(none)

Operation: GetServiceInfo Output (ServiceStatus) StatusNbr: This field returns a status number related to the operation.

Sample Output 200

StatusDescription: This field returns a description of the status

Found

Foreign Exchange Rates v.3.0.0

page 13

Operation: GetServiceInfo Output (ServiceStatus) number.

Sample Output

Operation: GetRemainingHits Input Note: The only input needed for this operation is the LicenseInfo data.

Sample Input (No input required)

Operation: GetRemainingHits Output (SubscriptionInfo) LicenseStatusCode: This field returns a numeric code indicating the StrikeIron license action taken as a result of invoking this operation from the User ID and Password used for input. Valid license codes are 0, 1, and 2. For example, a valid User ID and Password returns the code 0 with a corresponding LicenseStatus value of Valid license key.

Sample Output 0

LicenseStatus: This field returns the status of the StrikeIron User ID and Password corresponding to the LicenseStatusCode.

Valid license key

LicenseActionCode: This field returns a numeric code indicating the StrikeIron license action taken as a result of invoking this operation. GetRemainingHits returns the code 5 with a corresponding LicenseAction value of Get remaining hits.

0

LicenseAction: This field returns the license action taken as a result of invoking this operation from the User ID and Password used corresponding to the LicenseActionCode.

Decremented hit count

RemainingHits: This field returns the number of hits against the StrikeIron User ID and Password used when invoking this operation.

2

Amount: This field returns the number of hits used from the StrikeIron User ID provided to invoke this operation.

0

GetRemainingHitsResponse: This field only returns subscription information.

Foreign Exchange Rates v.3.0.0

page 14