AutoIt

Making SOAP Requests using the REST API

See more REST Examples

There's no reason a SOAP request cannot be sent using the REST API. It's only a matter of adding a SOAP specific header, and providing the SOAP XML request body. The response body is the SOAP response XML.

This example sends a request to ws.cdyne.com to get city weather by zip code.

AutoIt

Local $bSuccess = False

; Demonstrates how to do a SOAP request using the REST API.

; 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.
; --------------------------------------------------------------------------------

$oRest = ObjCreate("Chilkat.Rest")

; This is the request to be sent:

; POST /WeatherWS/Weather.asmx HTTP/1.1
; Host: wsf.cdyne.com
; Content-Type: text/xml; charset=utf-8
; Content-Length: length
; SOAPAction: "http://ws.cdyne.com/WeatherWS/GetCityWeatherByZIP"
; 
; <?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>
;     <GetCityWeatherByZIP xmlns="http://ws.cdyne.com/WeatherWS/">
;       <ZIP>string</ZIP>
;     </GetCityWeatherByZIP>
;   </soap:Body>
; </soap:Envelope>

; Note: The application does not need to set the Host or Content-Length headers.
; Chilkat will automatically add these headers.

; Make the initial connection (without sending a request yet).
Local $bTls = False
Local $iPort = 80
Local $bAutoReconnect = True
; In this particular case, it is important to connect to "wsf.cdyne.com", not "ws.cdyne.com"...
$bSuccess = $oRest.Connect("wsf.cdyne.com",$iPort,$bTls,$bAutoReconnect)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

; Add request headers:
$bSuccess = $oRest.AddHeader("Content-Type","text/xml; charset=utf-8")
$bSuccess = $oRest.AddHeader("SOAPAction","http://ws.cdyne.com/WeatherWS/GetCityWeatherByZIP")

; Build the SOAP XML request body.
$oSoapXml = ObjCreate("Chilkat.Xml")

$oSoapXml.Tag = "soap:Envelope"
$bSuccess = $oSoapXml.AddAttribute("xmlns:xsi","http://www.w3.org/2001/XMLSchema-instance")
$bSuccess = $oSoapXml.AddAttribute("xmlns:xsd","http://www.w3.org/2001/XMLSchema")
$bSuccess = $oSoapXml.AddAttribute("xmlns:soap","http://schemas.xmlsoap.org/soap/envelope/")

$oSoapXml.NewChild2 "soap:Body",""
$bSuccess = $oSoapXml.GetChild2(0)
$oSoapXml.NewChild2 "GetCityWeatherByZIP",""
$bSuccess = $oSoapXml.GetChild2(0)
$bSuccess = $oSoapXml.AddAttribute("xmlns","http://ws.cdyne.com/WeatherWS/")
$oSoapXml.NewChild2 "ZIP","60187"
$oSoapXml.GetRoot2 

ConsoleWrite($oSoapXml.GetXml() & @CRLF)

; Send the SOAP request
Local $sResponseXml = $oRest.FullRequestString("POST","/WeatherWS/Weather.asmx",$oSoapXml.GetXml())
If ($oRest.LastMethodSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

; When successful, the response status code will equal 200.
If ($oRest.ResponseStatusCode <> 200) Then
    ; Examine the request/response to see what happened.
    ConsoleWrite("response status code = " & $oRest.ResponseStatusCode & @CRLF)
    ConsoleWrite("response status text = " & $oRest.ResponseStatusText & @CRLF)
    ConsoleWrite("response header: " & $oRest.ResponseHeader & @CRLF)
    ConsoleWrite("response body (if any): " & $sResponseXml & @CRLF)
    ConsoleWrite("---" & @CRLF)
    ConsoleWrite("LastRequestStartLine: " & $oRest.LastRequestStartLine & @CRLF)
    ConsoleWrite("LastRequestHeader: " & $oRest.LastRequestHeader & @CRLF)
    Exit
EndIf

$oXml = ObjCreate("Chilkat.Xml")
$bSuccess = $oXml.LoadXml($sResponseXml)

; GetXml will emit XML that is nicely indented for human viewing..
ConsoleWrite($oXml.GetXml() & @CRLF)

; A sample response XML is shown below...

; To get some information, use ChilkatPath.  For example...
ConsoleWrite("Temperature: " & $oXml.ChilkatPath("soap:Body|GetCityWeatherByZIPResponse|GetCityWeatherByZIPResult|Temperature|*") & @CRLF)

ConsoleWrite("Success." & @CRLF)

; <?xml version="1.0" encoding="utf-8" ?>
; <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
;     <soap:Body>
;         <GetCityWeatherByZIPResponse xmlns="http://ws.cdyne.com/WeatherWS/">
;             <GetCityWeatherByZIPResult>
;                 <Success>true</Success>
;                 <ResponseText>City Found</ResponseText>
;                 <State>IL</State>
;                 <City>Wheaton</City>
;                 <WeatherStationCity>West Chicago</WeatherStationCity>
;                 <WeatherID>10</WeatherID>
;                 <Description>Mostly Sunny</Description>
;                 <Temperature>33</Temperature>
;                 <RelativeHumidity>39</RelativeHumidity>
;                 <Wind>VRB5</Wind>
;                 <Pressure>30.33F</Pressure>
;                 <Visibility />
;                 <WindChill />
;                 <Remarks />
;             </GetCityWeatherByZIPResult>
;         </GetCityWeatherByZIPResponse>
;     </soap:Body>
; </soap:Envelope>