Skip Navigation LinksHome > Products > Web Service Catalog > XigniteCurrencies

Web Service Operations GetCurrencyReport

Sign up for a free-trial now to test this operation!
From:
To:
StartDate:
EndDate:

Web Service Description

Returns historical currency cross-rate tables for a range of dates. The report can display up to 31 dates across.


Web Service Hits Calculation

Requests against this operation count as per cell in the report..

Inputs and Outputs Parameters for GetCurrencyReport

Inputs

NameDescriptionRequiredExample
FromThe source currency for the report. Use '*' to report on all available currenciesYes*
ToThe target currency for the report.YesEUR
StartDateThe start date for the report.Yes10/21/2009
EndDateThe end date for the report. The report will only display up to 31 days from the start date.Yes11/19/2009

Outputs

NameDescriptionAlways Present
ReportAn instance of currency representing the source currency. 
ToThe target currency.Yes
SymbolThe symbol for the currency.Yes
NameThe full name for the currency.Yes
Array of LinesReturns an array of Line. 
LineTypeThe type of line. The first line return is of type 'Header'. The following lines are of type 'Line'.Yes
FromThe From currency for the line.Yes
Value1The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value2The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value3The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value4The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value5The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value6The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value7The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value8The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value9The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value10The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value11The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value12The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value13The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value14The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value15The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value16The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value17The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value18The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value19The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value20The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value21The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value22The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value23The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value24The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value25The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value26The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value27The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value28The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value29The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value30The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No
Value31The value for the line. For the 'Header' type line, the value is date. For 'Line' type lines, the value is the value for the corresponding date.No

SOAP Request for GetCurrencyReport

Inputs

POST http://www.xignite.com/xCurrencies.asmx HTTP/1.1
Host: www.xignite.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.xignite.com/services/GetCurrencyReport"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <Header xmlns="http://www.xignite.com/services/">
      <Username>string</Username>
      <Password>string</Password>
      <Tracer>string</Tracer>
    </Header>
  </soap:Header>
  <soap:Body>
    <GetCurrencyReport xmlns="http://www.xignite.com/services/">
      <From>string</From>
      <To>string</To>
      <StartDate>string</StartDate>
      <EndDate>string</EndDate>
    </GetCurrencyReport>
  </soap:Body>
</soap:Envelope>

Outputs

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCurrencyReportResponse xmlns="http://www.xignite.com/services/">
      <GetCurrencyReportResult>
        <To>string</To>
        <Lines>
          <Line>
            <LineType>Header or Line</LineType>
            <From>string</From>
            <Value1>string</Value1>
            <Value2>string</Value2>
            <Value3>string</Value3>
            <Value4>string</Value4>
            <Value5>string</Value5>
            <Value6>string</Value6>
            <Value7>string</Value7>
            <Value8>string</Value8>
            <Value9>string</Value9>
            <Value10>string</Value10>
            <Value11>string</Value11>
            <Value12>string</Value12>
            <Value13>string</Value13>
            <Value14>string</Value14>
            <Value15>string</Value15>
            <Value16>string</Value16>
            <Value17>string</Value17>
            <Value18>string</Value18>
            <Value19>string</Value19>
            <Value20>string</Value20>
            <Value21>string</Value21>
            <Value22>string</Value22>
            <Value23>string</Value23>
            <Value24>string</Value24>
            <Value25>string</Value25>
            <Value26>string</Value26>
            <Value27>string</Value27>
            <Value28>string</Value28>
            <Value29>string</Value29>
            <Value30>string</Value30>
            <Value31>string</Value31>
          </Line>
          <Line>
            <LineType>Header or Line</LineType>
            <From>string</From>
            <Value1>string</Value1>
            <Value2>string</Value2>
            <Value3>string</Value3>
            <Value4>string</Value4>
            <Value5>string</Value5>
            <Value6>string</Value6>
            <Value7>string</Value7>
            <Value8>string</Value8>
            <Value9>string</Value9>
            <Value10>string</Value10>
            <Value11>string</Value11>
            <Value12>string</Value12>
            <Value13>string</Value13>
            <Value14>string</Value14>
            <Value15>string</Value15>
            <Value16>string</Value16>
            <Value17>string</Value17>
            <Value18>string</Value18>
            <Value19>string</Value19>
            <Value20>string</Value20>
            <Value21>string</Value21>
            <Value22>string</Value22>
            <Value23>string</Value23>
            <Value24>string</Value24>
            <Value25>string</Value25>
            <Value26>string</Value26>
            <Value27>string</Value27>
            <Value28>string</Value28>
            <Value29>string</Value29>
            <Value30>string</Value30>
            <Value31>string</Value31>
          </Line>
        </Lines>
      </GetCurrencyReportResult>
    </GetCurrencyReportResponse>
  </soap:Body>
</soap:Envelope>

HttpGet Request for GetCurrencyReport

Inputs

GET http://www.xignite.com/xCurrencies.asmx/GetCurrencyReport?
From=string&To=string&StartDate=string&EndDate=string HTTP/1.1
Host: www.xignite.com

Outputs

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Report xmlns="http://www.xignite.com/services/">
  <To>string</To>
  <Lines>
    <Line>
      <LineType>Header or Line</LineType>
      <From>string</From>
      <Value1>string</Value1>
      <Value2>string</Value2>
      <Value3>string</Value3>
      <Value4>string</Value4>
      <Value5>string</Value5>
      <Value6>string</Value6>
      <Value7>string</Value7>
      <Value8>string</Value8>
      <Value9>string</Value9>
      <Value10>string</Value10>
      <Value11>string</Value11>
      <Value12>string</Value12>
      <Value13>string</Value13>
      <Value14>string</Value14>
      <Value15>string</Value15>
      <Value16>string</Value16>
      <Value17>string</Value17>
      <Value18>string</Value18>
      <Value19>string</Value19>
      <Value20>string</Value20>
      <Value21>string</Value21>
      <Value22>string</Value22>
      <Value23>string</Value23>
      <Value24>string</Value24>
      <Value25>string</Value25>
      <Value26>string</Value26>
      <Value27>string</Value27>
      <Value28>string</Value28>
      <Value29>string</Value29>
      <Value30>string</Value30>
      <Value31>string</Value31>
    </Line>
    <Line>
      <LineType>Header or Line</LineType>
      <From>string</From>
      <Value1>string</Value1>
      <Value2>string</Value2>
      <Value3>string</Value3>
      <Value4>string</Value4>
      <Value5>string</Value5>
      <Value6>string</Value6>
      <Value7>string</Value7>
      <Value8>string</Value8>
      <Value9>string</Value9>
      <Value10>string</Value10>
      <Value11>string</Value11>
      <Value12>string</Value12>
      <Value13>string</Value13>
      <Value14>string</Value14>
      <Value15>string</Value15>
      <Value16>string</Value16>
      <Value17>string</Value17>
      <Value18>string</Value18>
      <Value19>string</Value19>
      <Value20>string</Value20>
      <Value21>string</Value21>
      <Value22>string</Value22>
      <Value23>string</Value23>
      <Value24>string</Value24>
      <Value25>string</Value25>
      <Value26>string</Value26>
      <Value27>string</Value27>
      <Value28>string</Value28>
      <Value29>string</Value29>
      <Value30>string</Value30>
      <Value31>string</Value31>
    </Line>
  </Lines>
</Report>

HttpPost Request for GetCurrencyReport

Inputs

POST http://www.xignite.com/xCurrencies.asmx/GetCurrencyReport HTTP/1.1
Host: www.xignite.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

From=string&To=string&StartDate=string&EndDate=string

Outputs

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Report xmlns="http://www.xignite.com/services/">
  <To>string</To>
  <Lines>
    <Line>
      <LineType>Header or Line</LineType>
      <From>string</From>
      <Value1>string</Value1>
      <Value2>string</Value2>
      <Value3>string</Value3>
      <Value4>string</Value4>
      <Value5>string</Value5>
      <Value6>string</Value6>
      <Value7>string</Value7>
      <Value8>string</Value8>
      <Value9>string</Value9>
      <Value10>string</Value10>
      <Value11>string</Value11>
      <Value12>string</Value12>
      <Value13>string</Value13>
      <Value14>string</Value14>
      <Value15>string</Value15>
      <Value16>string</Value16>
      <Value17>string</Value17>
      <Value18>string</Value18>
      <Value19>string</Value19>
      <Value20>string</Value20>
      <Value21>string</Value21>
      <Value22>string</Value22>
      <Value23>string</Value23>
      <Value24>string</Value24>
      <Value25>string</Value25>
      <Value26>string</Value26>
      <Value27>string</Value27>
      <Value28>string</Value28>
      <Value29>string</Value29>
      <Value30>string</Value30>
      <Value31>string</Value31>
    </Line>
    <Line>
      <LineType>Header or Line</LineType>
      <From>string</From>
      <Value1>string</Value1>
      <Value2>string</Value2>
      <Value3>string</Value3>
      <Value4>string</Value4>
      <Value5>string</Value5>
      <Value6>string</Value6>
      <Value7>string</Value7>
      <Value8>string</Value8>
      <Value9>string</Value9>
      <Value10>string</Value10>
      <Value11>string</Value11>
      <Value12>string</Value12>
      <Value13>string</Value13>
      <Value14>string</Value14>
      <Value15>string</Value15>
      <Value16>string</Value16>
      <Value17>string</Value17>
      <Value18>string</Value18>
      <Value19>string</Value19>
      <Value20>string</Value20>
      <Value21>string</Value21>
      <Value22>string</Value22>
      <Value23>string</Value23>
      <Value24>string</Value24>
      <Value25>string</Value25>
      <Value26>string</Value26>
      <Value27>string</Value27>
      <Value28>string</Value28>
      <Value29>string</Value29>
      <Value30>string</Value30>
      <Value31>string</Value31>
    </Line>
  </Lines>
</Report>

Sample Code for GetCurrencyReport

ASPX

<%@ Page Language="vb" %>
<%@ Import Namespace="System.Net" %>
<!-- here, XigniteCurrencies is the name of this assembly-->
<%@ Import Namespace="XigniteCurrencies" %>
<HTML>
<HEAD>
<script language="vb" runat="server">
' declare the return object globally so that you can reuse it around the page
Dim objReport As Report
' call the service inside the Page_Load routine 
Sub Page_Load(obj as object, e as eventargs)
     ' create an instance of the web service 
     Dim objCurrenciesService As New XigniteCurrencies()
     ' call the operation and load the return object 
     objReport =
     objCurrenciesService.
          GetCurrencyReport("*", "EUR", "10/21/2009", "11/19/2009")
     If Not objReport Is Nothing Then
          Select Case objReport.Outcome
               Case OutcomeTypes.RegistrationError
                    ' add processing for handling subscription problems, e.g.
                    Response.Write("Our subscription to this service has expired.")
               Case OutcomeTypes.RequestError
                    ' add processing for handling request problems, e.g. 
                    ' you could pass back the info message received from the service
                    Response.Write(objReport.Message)
               Case OutcomeTypes.SystemError
                    ' add processing for handling system problems, e.g. 
                    Response.Write("Service is unavailable at this time.")
          End Select
     Else
          ' add error processing here 
          ' this condition could be caused by an HTTP error (404,500...)
          Response.Write("Service is unavailable at this time.")
     End If
End Sub
</script>
</HEAD>
<BODY>
<TABLE>
     <TR>
          <TD>
          <!-- add processing for displaying the results, e.g. -->
          <!-- display the value for To-->
          <!-- other values could be consumed in the same manner-->
          <%Response.Write(objReport.To) %>
          </TD>
     </TR>
</TABLE>
</BODY>
</HTML>

C# (CSharp)

RemoteCurrencies.XigniteCurrencies objCurrenciesService;
objCurrenciesService = new RemoteCurrencies.XigniteCurrencies();
RemoteCurrencies.Report objReport;
objReport = 
      objCurrenciesService.
          GetCurrencyReport("*", "EUR", "10/21/2009", "11/19/2009");
if (objReport == null)
{
     /// add error processing here 
     /// this condition could be caused by an HTTP error (404,500...)
     Console.Write("Service is unavailable at this time.");
}
else
{
     switch(objReport.Outcome)
     {
          case RemoteCurrencies.OutcomeTypes.Success:
               /// add processing for displaying the results, e.g. 
               /// display the value for To
               /// other values could be consumed in the same manner
               Console.Write(objReport.To);
               break;
          default:
               /// add processing for handling request problems, e.g. 
               /// you could pass back the info message received from the service 
               Console.Write(objReport.Message);
               break;
     }
}

Classic ASP

This code requires the Microsoft SOAP Toolkit 3.0 and MSXML 4.0. You can download these from the Microsoft site.

Dim objSOAPClient
Set objSOAPClient = Server.CreateObject("MSSOAP.SoapClient30")
' the node list is of type MSXML2.IXMLDOMNodeList
Dim objXMLNodeList
' the node is of type MSXML2.IXMLDOMNode
Dim objXMLNode

' initialize the soap engine
objSOAPClient.ClientProperty("ServerHTTPRequest") = True
objSOAPClient.MSSoapInit("http://www.xignite.com/xCurrencies.asmx?WSDL")

' load the node list with the records received from the service
Set objXMLNodeList = objSOAPClient.GetCurrencyReport("*", "EUR", "10/21/2009", "11/19/2009")

' loop through the index records and load in the document
For Each objXMLNode In objXMLNodeList
     ' your can print out the content of each node
     Response.Write objXMLNode.xml
Next

Java/Axis

This section assumes that you have Axis installed on your machine and that you are fairly familiar with it.

Because all our web services return complex types, the best way to use Axis is to first generate a proxy class using the 'WSDL2Java' tool'. By default, the tool will put all generated classes into the package "com.xignite.www.services".

You should then compile the classes:


C:\axis>java org.apache.axis.wsdl.WSDL2Java http://www.xignite.com/xCurrencies.asmx?WSDL
C:\axis>javac com\xignite\*.java
C:\axis>

You can then create your source file.


// By default, all of the classes auto-generated by the Axis 
// "WSDL2Java" tool are placed into the package "com.xignite.www.services" 
// for our Xignite WSDL, so we need an import.
import com.xignite.www.services.*;
public class XigniteCurrenciesDemo  {
     public static void main(String[] args) throws Exception {
     // Instantiate the XigniteCurrencies proxy 
     // proxy object using the Helper class.
     // This class was autogenerated by the WSDL2Java tool

          try {
               XigniteCurrencies objCurrenciesService = new XigniteCurrenciesLocator();
               XigniteCurrenciesSoap objCurrenciesPort = objCurrenciesService.getXigniteCurrenciesSoap();

               // Instantiate the return class from the operation
               // This class was autogenerated by the WSDL2Java tool
               Report objReport = objCurrenciesPort.getCurrencyReport("*", "EUR", "10/21/2009", "11/19/2009");
               // objReport is pointing to the result of the operation
               if (objReport.getOutcome() == OutcomeTypes.RegistrationError)
               {
                    // code to handle registration errors
                    System.out.println(OutcomeTypes.RegistrationError.toString() + ": " + objReport.getMessage());
               }
               else if (objReport.getOutcome() == OutcomeTypes.RequestError)
               {
                    // code to handle request errors
                    System.out.println(OutcomeTypes.RequestError.toString() + ": " + objReport.getMessage());
               }
               else if (objReport.getOutcome() == OutcomeTypes.SystemError)
               {
                    // code to handle system errors
                    System.out.println(OutcomeTypes.SystemError.toString() + ": " + objReport.getMessage());
               }
               else    // Success
               {
                    System.out.println(objReport.getTo());
               }
          }
          catch (Exception ex) {
          // add exception handling code here

          }
     }
}

Apache Axis2 1.4+
C:\axis>wsdl2java.bat -ap -uri http://www.xignite.com/xCurrencies.asmx?WSDL
C:\axis>javac com\xignite\*.java
C:\axis>

You can then create your source file.

// By default, all of the classes auto-generated by the Axis2 
// "WSDL2Java" tool are placed into the package "com.xignite.www.services" 
// for our Xignite WSDL, so we need an import.
import com.xignite.www.services.XigniteCurrenciesXigniteCurrenciesSoapStub;
import com.xignite.www.services.XigniteCurrenciesXigniteCurrenciesSoapStub.*;

public class XigniteCurrenciesDemo  {

     public static void main(String[] args) throws Exception {
     // Instantiate the XigniteCurrencies proxy 
     // proxy object using the Helper class.
     // This class was autogenerated by the WSDL2Java tool

          try {
               XigniteCurrenciesXigniteCurrenciesSoapStub stub = new XigniteCurrenciesXigniteCurrenciesSoapStub();
               // Instantiate the return class from the operation
               // This class was autogenerated by the WSDL2Java tool
               GetCurrencyReport getCurrencyReportArguments = new GetCurrencyReport();
               getCurrencyReportArguments.setFrom("*");
               getCurrencyReportArguments.setTo("EUR");
               getCurrencyReportArguments.setStartDate("10/21/2009");
               getCurrencyReportArguments.setEndDate("11/19/2009");

               GetCurrencyReportResponse response = stub.GetCurrencyReport(getCurrencyReportArguments, null);
               Report objReport = response.getGetCurrencyReportResult();
               // objReport is pointing to the result of the operation
               if (objReport.getOutcome() == OutcomeTypes.RegistrationError)
               {
                    // code to handle registration errors
                    System.out.println(OutcomeTypes.RegistrationError.toString() + ": " + objReport.getMessage());
               }
               else if (objReport.getOutcome() == OutcomeTypes.RequestError)
               {
                    // code to handle request errors
                    System.out.println(OutcomeTypes.RequestError.toString() + ": " + objReport.getMessage());
               }
               else if (objReport.getOutcome() == OutcomeTypes.SystemError)
               {
                    // code to handle system errors
                    System.out.println(OutcomeTypes.SystemError.toString() + ": " + objReport.getMessage());
               }
               else    // Success
               {
                    System.out.println(objReport.getTo());
               }
          }
          catch (Exception ex) {
          // add exception handling code here

          }
     }
}

PHP/NuSoap

NuSoap is one of the three major SOAP implementations for PHP: PEAR::SOAP, NuSOAP, and PHP-SOAP.

If you use PHP, we recommend you use NuSoap to access our web services. NuSoap uses our web services for demonstration in their own documentation and it works well.

This section assumes that you have PHP installed on your machine and that you are fairly familiar with it. We have tested this implementation for PHP 4.2.1 on Windows 2000. It should also work with more recent versions on more recent platforms. Note that PHP 5.0 supports SOAP natively (without extension), please follow their documentation for upgrade or code changes required.

To install NuSoap, download the latest package from this location. You can unzip the package in your PHP application directory. The package includes libraries (/lib) and samples (/samples). The sample code below is based on the wsdlclient1.php sample.

If you use one of the older version or PHP (i.e. 4.2.1) , you will need to comment out one line in the /lib/nusoap.php file. That section is not supported in earlier version. The line to comment out is line 1877 as shown below.


1876 // set response timeout
1877 //socket_set_timeout( $this->fp, $response_timeout);

You can then create your source file.


<?php
// need to use the NuSoap extension 
require_once('../lib/nusoap.php');

// if you access the internet through a proxy server 
$proxyhost = isset($_POST['proxyhost']) ? $_POST['proxyhost'] : '';
$proxyport = isset($_POST['proxyport']) ? $_POST['proxyport'] : '';
$proxyusername = isset($_POST['proxyusername']) ? $_POST['proxyusername'] : '';
$proxypassword = isset($_POST['proxypassword']) ? $_POST['proxypassword'] : '';

// define the SOAP client using the url for the service 
$client = new soapclient('http://www.xignite.com/xCurrencies.asmx?WSDL', 
               true, $proxyhost, $proxyport, $proxyusername, $proxypassword);

// assess the results 
$err = $client->getError();
if ($err) {
     echo '<h2>Constructor error</h2><pre>' . $err . '</pre>';
}

// create an array of parameters 
$param = array(
               'From' => "*",
               'To' => "EUR",
               'StartDate' => "10/21/2009",
               'EndDate' => "11/19/2009");



// call the service, passing the parameters and the name of the operation 
$result = $client->call('GetCurrencyReport', array('parameters' => $param), '', '', false, true);
// assess the results 
if ($client->fault) {
     echo '<h2>Fault</h2><pre>';
     print_r($result);
     echo '</pre>';
} else {
     $err = $client->getError();
     if ($err) {
          echo '<h2>Error</h2><pre>' . $err . '</pre>';
     } else {
// display the results 
          echo '<h2>Result</h2><pre>';
// this function exposes the complete structure of the return class 
          print_r($result);
          echo '</pre>';
     }
}
// print the SOAP request 
echo '<h2>Request</h2><pre>' . htmlspecialchars($client->request, ENT_QUOTES) . '</pre>';
// print the SOAP response 
echo '<h2>Response</h2><pre>' . htmlspecialchars($client->response, ENT_QUOTES) . '</pre>';
// print the PHP debugging trace 
echo '<h2>Debug</h2><pre>' . htmlspecialchars($client->debug_str, ENT_QUOTES) . '</pre>';
?>

PHP5

PHP-SOAP is one of the three major SOAP implementations for PHP: PEAR::SOAP, NuSOAP, and PHP-SOAP.

This section assumes that you have PHP5.0 installed on your machine and that you are fairly familiar with it.

Note that PHP 5.0 supports SOAP, please follow their documentation for code changes required.

Here is a sample source for this operation.

<?php
// define the SOAP client using the url for the service
$client = new soapclient('http://www.xignite.com/xCurrencies.asmx?WSDL', array('trace' => 1));

// create an array of parameters 
$param = array(
               'From' => "*",
               'To' => "EUR",
               'StartDate' => "10/21/2009",
               'EndDate' => "11/19/2009");



// call the service, passing the parameters and the name of the operation 
$result = $client->GetCurrencyReport($param);
// assess the results 
if (is_soap_fault($result)) {
     echo '<h2>Fault</h2><pre>';
     print_r($result);
     echo '</pre>';
} else {
     echo '<h2>Result</h2><pre>';
     print_r($result);
     echo '</pre>';
}
// print the SOAP request 
echo '<h2>Request</h2><pre>' . htmlspecialchars($client->__getLastRequest(), ENT_QUOTES) . '</pre>';
// print the SOAP request Headers 
echo '<h2>Request Headers</h2><pre>' . htmlspecialchars($client->__getLastRequestHeaders(), ENT_QUOTES) . '</pre>';
// print the SOAP response 
echo '<h2>Response</h2><pre>' . htmlspecialchars($client->__getLastResponse(), ENT_QUOTES) . '</pre>';
?>

Perl/SoapLite

This section assumes that you have SOAP::Lite for Perl installed on your machine and that you are fairly familiar with it. But just in case your are not:

You can then use a text editor to create the source code below. You can execute it by running:


C:\perl\perl demo.pl

Note that there are some unique steps to follow to use SOAP::Lite with .Net web Services. For detailed info, check this article on MSDN.

Here is a sample source for this operation.
# the maptype instruction is critical for compatibility 
use SOAP::Lite maptype => {};

# this is our namespace
my $namespace = 'http://www.xignite.com/services/';

# declare the service using the namespace, the SOAP action and the uri
my $service = SOAP::Lite 
    -> uri($namespace)
    -> on_action( sub { join '/', 'http://www.xignite.com/services', $_[1] } )
    -> proxy('http://www.xignite.com/xCurrencies.asmx');

# .Net requires the method, header, and attributes to be fully qualified
my $method = SOAP::Data->name('GetCurrencyReport')
             ->attr({xmlns => $namespace});

# this section is required for authentication
# you can skip it if you use IP-based authentication
my $header = SOAP::Header->name(Header => {
             Username => '<your username here>'})->uri($namespace)->prefix('');

# same here, you can omit $header if you use IP-based authentication 

my @params = ( $header,
               SOAP::Data->name(From => '*')->uri($namespace),
               SOAP::Data->name(To => 'EUR')->uri($namespace),
               SOAP::Data->name(StartDate => '10/21/2009')->uri($namespace),
               SOAP::Data->name(EndDate => '11/19/2009')->uri($namespace));


# you can now call the service
my $result =  $service->call($method => @params);
if ($result->fault)
{
     print $result->faultstring;
}
else
{
# here we parse the output using the main return class
# and one of its attributes
# check here for the output structure
     print $result->valueof('//GetCurrencyReportResult/To'), "\n";
}

VB.NET

Dim objCurrenciesService As New RemoteCurrencies.XigniteCurrencies()
Dim objReport As RemoteCurrencies.Report _
           = objCurrenciesService.GetCurrencyReport("*", "EUR", "10/21/2009", "11/19/2009")
If Not objReport Is Nothing Then
     Select Case objReport.Outcome
          Case RemoteCurrencies.OutcomeTypes.RegistrationError
               ' display the error to facilitate diagnostics, e.g.
               Console.WriteLine(objReport.Message)
          Case RemoteCurrencies.OutcomeTypes.RequestError
               ' add processing for handling request problems, e.g. 
               ' you could pass back the info message received from the service
               Console.WriteLine(objReport.Message)
          Case RemoteCurrencies.OutcomeTypes.SystemError
               ' add processing for handling system problems, e.g. 
               Console.WriteLine("Service is unavailable at this time.")
          Case Else
               ' add processing for displaying the results, e.g. 
               ' display the value for To
               ' other values could be consumed in the same manner
               Console.WriteLine(objReport.To)

     End Select
Else
     ' add error processing here 
     ' this condition could be caused by an HTTP error (404,500...)
     Console.WriteLine("Service is unavailable at this time.")
End If

VB6

' this DOM object will contain the result of the call
Dim objResult As IXMLDOMSelection
' create an instance of the soap toolkit
Dim objService As New MSSOAPLib30.SoapClient30
' if your network uses a proxy server, add this line
objService.ConnectorProperty("ProxyServer") = "ip of your proxy server"
' SOAP headers are not supported in the toolkit, so we will fake it with this handler
Dim objHeader As ClientHeaderHandler
Set objHeader = New ClientHeaderHandler
' set the username and passwords to your values
objHeader.Username = "myusername"
objHeader.Password = "mypassword"
Set objService.HeaderHandler = objHeader

' point the the toolkit to the WSDL
objService.mssoapinit "http://www.xignite.com/xCurrencies.asmx?WSDL"

' load the result into the DOM object
Set objResult = objService.GetCurrencyReport("*",
"EUR",
"10/21/2009",
"11/19/2009")



' you can access the properties this way:
' where objResult(5).nodeName is the name of the 5th field of the instance returned
' and objResult(5).Text is the value
MsgBox objResult(5).nodeName & " = " & objResult(5).Text


' you must also add this class to your code. 
' it will create the SOAP header to pass with your request 
Class Module "ClientHeaderHandler"
Option Explicit
Implements IHeaderHandler

Private m_uid As String
Private m_pwd As String
Private m_tracer As String

Property Let Username(ByVal value As String)
     m_uid = value
End Property

Property Let Password(ByVal value As String)
     m_pwd = value
End Property

Property Let Tracer(ByVal value As String)
     m_tracer = value
End Property

Private Function iHeaderHandler_ReadHeader( _
     ByVal par_reader As MSSOAPLib30.ISoapReader, _
     ByVal par_HeaderNode As MSXML2.IXMLDOMNode, _
     ByVal par_object As Object) As Boolean
     iHeaderHandler_ReadHeader = False
End Function

Private Function iHeaderhandler_willWriteHeaders() As Boolean
     iHeaderhandler_willWriteHeaders = True
End Function

Private Sub iHeaderHandler_WriteHeaders( _
     ByVal par_serializer As MSSOAPLib30.ISoapSerializer, _
     ByVal par_object As Object)

     Dim XigniteHeaderString As String

     XigniteHeaderString = "<Header xmlns="http://www.xignite.com/services/"> " & _
          "<Username>" & m_uid  & "</Username>" & _
          "<Password>" & m_pwd  & "</Password>" & _
          "<Tracer>" & m_tracer & "</Tracer>" & _
          "</Header>"

     par_serializer.WriteXml XigniteHeaderString
End Sub

XSLT

When working with XSL, you only need to worry about properly dealing with namespaces.

The general principle in working with XSL is to apply the stylesheet (the XSL document) to the output of the web service (XML document). The code required to accomplish this varies based on your envirobment. For instance, using VB.Net it would be:

Dim objSOAPClient
Dim objTemplate As New System.Xml.Xsl.XslTransform()
objTemplate.Load(<url_of_XSL_template>)
objTemplate.Transform(<url_of_input_document>,<url_of_output_document>)

In the code above, you want to replace the <url_of_input_document> with the following URL.

http://www.xignite.com/xCurrencies.asmx/GetCurrencyReport?From=*&To=EUR&StartDate=10/21/2009&EndDate=11/19/2009


And this is how you could write the XSL stylesheet. Note that all node names are prefixed.

<?xml version="1.0"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 
     xmlns:xi="http://www.xignite.com/services/"
      version="1.0" exclude-result-prefixes="xi">
<xsl:template match="xi:Report>
     <p>
          <xsl:value-of select="xi:To/>
     </p>
</xsl:template>
</xsl:stylesheet>

 
Copyright © 2009 Xignite, Inc. All Rights Reserved.




Hostname: xignite24