Calling XML Document Based Web Service

WSDL Tutorials - Herong's Tutorial Examples

∟Using WSDL in Perl with SOAP::Lite 0.710

∟Calling XML Document Based Web Service

This section provides a tutorial example on how to call an XML document based Web service defined a WSDL 1.1 document with SOAP 1.1 binding.

After learning SOAP::Data and related classes, I hope I am ready to use SOAP::Lite to call my XML document based Web service defined in the WSDL document at http://www.herongyang.com/Service/ Registration_WSDL_11_SOAP_11_Document.wsdl Here is an example Perl program, Registration_Client.pl:

#- Registration_Client.pl
#- Copyright (c) 2009 by Dr. Herong Yang, herongyang.com
#- All rights reserved
#
   use SOAP::Lite +trace;

#- Loading the WSDL document
   my $client = SOAP::Lite->service(
      'file:///c:/herong/Registration_WSDL_11_SOAP_11_Document.wsdl');

#- Making the SOAP message in a readable format
   $client->readable('true');

#- Building the XML document
   $guest1 = SOAP::Data->new(name=>'Guest', value=>'Herong Yang');
   $guest2 = SOAP::Data->name('Guest')->value('Joe Smith');

   $list = SOAP::Data->new();
   $list->value($guest1, $guest2);

   $request = SOAP::Data->new();
   $request->name('RegistrationRequest');
   $request->attr({'event'=>'OpenGame', 'date'=>'2008-08-08'});
   $request->value(\$list);

#- Calling the operation
   $result = $client->Registration($request);

#- Showing the result
   print "Result is: $result\n";

Execution result of Registration_Client.pl:

C:\herong\>Registration_Client.pl
SOAP::Transport::HTTP::Client::send_receive: 
   POST http://www.herongyang.com/Service/Registration.php HTTP/1.1
Accept: text/xml
Accept: multipart/*
Accept: application/soap
Content-Length: 805
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://www.herongyang.com/Service/Registration"

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope
    xmlns:hy="http://www.herongyang.com/Service/"
    soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <hy:Registration>
      <RegistrationRequest date="2008-08-08" event="OpenGame">
        <Guest xsi:type="xsd:string">Herong Yang</Guest>
        <Guest xsi:type="xsd:string">Joe Smith</Guest>
      </RegistrationRequest>
    </hy:Registration>
  </soap:Body>
</soap:Envelope>
SOAP::Transport::HTTP::Client::send_receive:
   HTTP::Response=HASH(0x1ff4800)
SOAP::Transport::HTTP::Client::send_receive: HTTP/1.1 200 OK
...

Do you see any wrong with the SOAP request message generated by SOAP::Lite? I do:

The Web service method call Registration() automatically create the first level sub element in the SOAP Body element with the method name, "Registration", as the element name.
The XML element, RegistrationRequest, represented by the method call argument, $request, is placed as the sub element inside "Registration".
The final SOAP Body element does not match what is expected by my WSDL document, which requires the "RegistrationRequest" element to be the first level sub element.

Conclusion, SOAP::Lite automatically generates the first level sub element of the SOAP Body element using the Web service method name, which is the operation name defined in the WSDL document.

In other word, the element name of the input message part must be the same as the name of the operation if you are defining a XML document based Web service and want to use SOAP::Lite to call it.

Last update: 2009.

Table of Contents

About This Book

Introduction to WSDL 2.0

WSDL 2.0 Document Structure and Syntax

WSDL Version 2.0 Part 2: Adjuncts

WSDL 2.0 Document Examples with SOAP Binding

WSDL 20 Programming APIs and Testing Tools

Introduction to WSDL 1.1

WSDL 1.1 Document Structure and Syntax

WSDL 1.1 Binding Extension for SOAP 1.1

soapUI 3.0.1 - Web Service Testing Tool