<%@ Page Language="vb" %>
<%@ Import Namespace="System.Net" %>
<!-- here, XigniteHelp is the name of this assembly-->
<%@ Import Namespace="XigniteHelp" %>
<HTML>
<HEAD>
<script language="vb" runat="server">
' declare the return object globally so that you can reuse it around the page
Dim objUserSummary As UserSummary
' 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 objHelpService As New XigniteHelp()
' add authentication info
Dim objHeader As New RemoteHelp.Header = new Header();
objHeader.Username = "YOUR_TOKEN"
objUserSummary.HeaderValue = objHeader
' call the operation and load the return object
objUserSummary = objHelpService.
GetMyStatus()
If Not objUserSummary Is Nothing Then
Select Case objUserSummary.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(objUserSummary.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 objUserSummary.Registrations(0).Updated-->
<!-- other values could be consumed in the same manner-->
<%Response.Write(objUserSummary.Registrations(0).Updated)%>
</TD>
</TR>
</TABLE>
</BODY>
</HTML>
This code could be used in any type of application (Windows, console ...). Here, RemoteHelp is the web reference to the web service. Note that the default name for a web reference is generally "com.xignite.www". You will need to rename your web reference to use to use this code.
RemoteHelp.XigniteHelp objHelpService;
objHelpService = new RemoteHelp.XigniteHelp();
// add authentication info
RemoteHelp.Header objHeader = new RemoteHelp.Header();
objHeader.Username = "YOUR_TOKEN";
objHelpService.HeaderValue = objHeader;
RemoteHelp.UserSummary objUserSummary;
objUserSummary = objHelpService.
GetMyStatus();
if (objUserSummary == 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(objUserSummary.Outcome)
{
case RemoteHelp.OutcomeTypes.Success:
// add processing for displaying the results, e.g.
// display the value for objUserSummary.Registrations[0].Updated
// other values could be consumed in the same manner
Console.Write(objUserSummary.Registrations[0].Updated);
break;
default:
// add processing for handling request problems, e.g.
// you could pass back the info message received from the service
Console.Write(objUserSummary.Message);
break;
}
}
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 (Apache Axis2 1.4+) 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 (including the axis dependencies):
C:\axis>java org.apache.axis.wsdl.WSDL2Java http://www.xignite.com/xHelp.asmx?WSDL
C:\axis>javac com\xignite\*.java
C:\axis>
C:\axis>YOUR_AXIS_INSTALLATION\bin\wsdl2java.bat -ap -uri http://www.xignite.com/xHelp.asmx?WSDL
C:\axis>javac -classpath "YOUR_AXIS_INSTALLATION/lib/*" com/xignite/www/services/*.java
You can then create your source file. See below
After creating your source file, you can compile it like this:
C:\axis>javac -classpath .;"YOUR_AXIS_INSTALLATION/lib/*" XigniteHelpDemo.java
// 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.XigniteHelpXigniteHelpSoapStub;
import com.xignite.www.services.XigniteHelpXigniteHelpSoapStub.*;
public class XigniteHelpDemo {
public static void main(String[] args) throws Exception {
// Instantiate the XigniteHelp proxy
// proxy object using the Helper class.
// This class was autogenerated by the WSDL2Java tool
try {
XigniteHelpXigniteHelpSoapStub stub = new XigniteHelpXigniteHelpSoapStub();
// Instantiate the return class from the operation
// This class was autogenerated by the WSDL2Java tool
GetMyStatus getMyStatusArguments = new GetMyStatus();
// Add authentication info
HeaderE header = new HeaderE();
Header myHeader = new Header();
myHeader.setUsername("YOUR_TOKEN");
header.setHeader(myHeader);
GetMyStatusResponse response = stub.getMyStatus(getMyStatusArguments, header);
UserSummary objUserSummary = response.getGetMyStatusResult();
// objUserSummary is pointing to the result of the operation
if (objUserSummary.getOutcome() == OutcomeTypes.RegistrationError)
{
// code to handle registration errors
System.out.println(OutcomeTypes.RegistrationError.toString() + ": " + objUserSummary.getMessage());
}
else if (objUserSummary.getOutcome() == OutcomeTypes.RequestError)
{
// code to handle request errors
System.out.println(OutcomeTypes.RequestError.toString() + ": " + objUserSummary.getMessage());
}
else if (objUserSummary.getOutcome() == OutcomeTypes.SystemError)
{
// code to handle system errors
System.out.println(OutcomeTypes.SystemError.toString() + ": " + objUserSummary.getMessage());
}
else // Success
{
System.out.println(objUserSummary.getRegistrations()[0].getUpdated());
}
}
catch (Exception ex) {
// add exception handling code here
}
}
}
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 => {};
use Data::Dumper;
# 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/xHelp.asmx');
# .Net requires the method, header, and attributes to be fully qualified
my $method = SOAP::Data->name('GetMyStatus')
->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,
);
# 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
# Uncoment the line below to print the full result object graph:
# print Dumper($result);
print $result->valueof('//GetMyStatusResult/objUserSummary/Registrations[0]/Updated'), "\n";
}
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/xHelp.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(
);
// call the service, passing the parameters and the name of the operation
$result = $client->call('GetMyStatus', 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>';
?>
<?php
// Initialize CURL resource
$ch = curl_init();
// Set URL for service, replace placeholder USER_TOKEN with valid API token
curl_setopt($ch, CURLOPT_URL, 'http://www.xignite.com/xHelp.json/GetMyStatus?&_token=USER_TOKEN');
// Set response type as string
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
// Execute curl request
$output = curl_exec($ch);
// Close curl resource
curl_close($ch);
print($output)
?>
This section assumes that you have some knowledge of the Ruby language, and in particular the SOAP library Savon version 2.
require 'rubygems'
require 'savon'
require 'pp'
url = "http://www.xignite.com/xHelp.asmx?WSDL"
soap_header = {
"Header" => {
"@xmlns" => "http://www.xignite.com/services/",
"Username" => "YOUR_TOKEN"
}
}
client = Savon.client(wsdl: url, :soap_header => soap_header, convert_request_keys_to: :none, env_namespace: 'soap')
response = client.call(:get_my_status, message: {
"@xmlns" => "http://www.xignite.com/services/",
})
pp response.to_hash
Dim objHelpService As New RemoteHelp.XigniteHelp()
Dim objHeader As New RemoteHelp.Header = new RemoteHelp.Header();
objHeader.Username = "YOUR_TOKEN"
objHelp.HeaderValue = objHeader
Dim objUserSummary As RemoteHelp.UserSummary _
= objHelpService.GetMyStatus()
If Not objUserSummary Is Nothing Then
Select Case objUserSummary.Outcome
Case RemoteHelp.OutcomeTypes.RegistrationError
' display the error to facilitate diagnostics, e.g.
Console.WriteLine(objUserSummary.Message)
Case RemoteHelp.OutcomeTypes.RequestError
' add processing for handling request problems, e.g.
' you could pass back the info message received from the service
Console.WriteLine(objUserSummary.Message)
Case RemoteHelp.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 objUserSummary.Registrations(0).Updated
' other values could be consumed in the same manner
Console.WriteLine(objUserSummary.Registrations(0).Updated)
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
' 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 = "YOUR_TOKEN"
Set objService.HeaderHandler = objHeader
' point the the toolkit to the WSDL
objService.mssoapinit "http://www.xignite.com/xHelp.asmx?WSDL"
' load the result into the DOM object
Set objResult = objService.GetMyStatus()
' 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
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/xHelp.asmx/GetMyStatus?
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:UserSummary">
<p>
<xsl:value-of select="xi:Registrations/xi:Updated"/>
</p>
</xsl:template>
</xsl:template></xsl:stylesheet>
The sample code is provided "as is" without any express or implied warranty. You are solely responsible for obtaining any necessary licenses or ownership rights, including for Xignite APIs and open source code, to use this sample code. Xignite has no obligation to test, certify, or support its use.