SOAP Web Service (HTTP POST)

Demonstrates how to call PostXml to call a SOAP web service.

Download Chilkat Ruby Library

require 'chilkat'


http = Chilkat::CkHttp.new()

#  Any string unlocks the component for the 1st 30-days.
success = http.UnlockComponent("Anything for 30-day trial")
if (success != true)
    print http.lastErrorText() + "\n"
    exit
end

#  This example uses a live web service at:
#  http://www.webservicex.net/uklocation.asmx
#  It gets the UK town,Postcode and County by Postcode(First Section of Post Code)

#  The SOAP XML will look like this:
#  <?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>
#      <GetUKLocationByPostCode xmlns="http://www.webserviceX.NET">
#        <PostCode>string</PostCode>
#      </GetUKLocationByPostCode>
#    </soap:Body>
#  </soap:Envelope>

#  For this example's sake, we'll load the XML from a file.  We'll test using PostCode "E3".
#  The SOAP XML for this example may be downloaded from:
#  http://www.chilkatsoft.com/testData/ukPostCodeSoap.xml
xml = Chilkat::CkXml.new()
success = xml.LoadXmlFile("ukPostCodeSoap.xml")
if (success != true)
    print xml.lastErrorText() + "\n"
    exit
end

strXml = xml.getXml()

#  We'll need to add this in the HTTP header:
#  SOAPAction: "http://www.webserviceX.NET/GetUKLocationByPostCode"
http.SetRequestHeader("SOAPAction","http://www.webserviceX.NET/GetUKLocationByPostCode")

#  Some services expect the content-type in the HTTP header to be "application/xml" while
#  other expect text/xml.  The default sent by Chilkat is "application/xml", but this web service
#  expects "text/xml".  Therefore, change the content-type:
http.SetRequestHeader("Content-Type","text/xml; charset=utf-8")

#  The endpoint for this soap service is:
endPoint = "http://www.webservicex.net/uklocation.asmx"

#  Note: This particular web service was live and functioning at the time this example
#  was written.  It is possible that as time progresses, this web service will no longer
#  be availble...
# resp is a CkHttpResponse
resp = http.PostXml(endPoint,strXml,"utf-8")
if (resp == nil )
    print http.lastErrorText() + "\n";

    print "LastHeader:" + "\n";
    print http.lastHeader() + "\n";
else

    responseStatusCode = resp.get_StatusCode()
    #  You may wish to verify that the responseStatusCode equals 200...
    print "Response Status Code: " + responseStatusCode.to_s() + "\n";

    #  You may examine the exact HTTP header sent with the POST like this:
    print "LastHeader:" + "\n";
    print http.lastHeader() + "\n";

    #  Examine the XML returned by the web service:
    print "XML Response:" + "\n";
    xmlResp = Chilkat::CkXml.new()
    success = xmlResp.LoadXml(resp.get_BodyStr())
    #  Assume the LoadXml is successful...
    #  Get rid of the SOAP wrappings and get to the meat of this particular response.
    #  The TagContent method returns the content of the 1st node in the XML document
    #  having a specific tag:

    unwrappedXml = xmlResp.tagContent("GetUKLocationByPostCodeResult")
    print unwrappedXml + "\n";

    #  The unwrapped XML could be loaded into an XML object and parsed...
    xmlMeat = Chilkat::CkXml.new()
    success = xmlMeat.LoadXml(unwrappedXml)

    #  ...
end