(Tcl) SOAP Web Service (HTTP POST)

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# --------------------------------------------------------------------------------
# Also see Chilkat's Online WSDL Code Generator
# to generate code and SOAP Request and Response XML for each operation in a WSDL.
# --------------------------------------------------------------------------------

# 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
set xml [new_CkXml]

set success [CkXml_LoadXmlFile $xml "ukPostCodeSoap.xml"]
if {$success != 1} then {
    puts [CkXml_lastErrorText $xml]
    delete_CkXml $xml
    exit
}

set strXml [CkXml_getXml $xml]

set http [new_CkHttp]

# We'll need to add this in the HTTP header:
# SOAPAction: "http://www.webserviceX.NET/GetUKLocationByPostCode"
CkHttp_SetRequestHeader $http "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:
CkHttp_SetRequestHeader $http "Content-Type" "text/xml; charset=utf-8"

# The endpoint for this soap service is:
set 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
set resp [CkHttp_PostXml $http $endPoint $strXml "utf-8"]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    puts "LastHeader:"
    puts [CkHttp_lastHeader $http]
    delete_CkXml $xml
    delete_CkHttp $http
    exit
}

set responseStatusCode [CkHttpResponse_get_StatusCode $resp]
# You may wish to verify that the responseStatusCode equals 200...
puts "Response Status Code: $responseStatusCode"

# You may examine the exact HTTP header sent with the POST like this:
puts "LastHeader:"
puts [CkHttp_lastHeader $http]

# Examine the XML returned by the web service:
puts "XML Response:"
set xmlResp [new_CkXml]

CkXml_LoadXml $xmlResp [CkHttpResponse_bodyStr $resp]
puts [CkXml_getXml $xmlResp]

# Use this online tool to generate parsing code from response XML: 
# Generate Parsing Code from XML

delete_CkHttpResponse $resp


delete_CkXml $xml
delete_CkHttp $http
delete_CkXml $xmlResp