(PowerBuilder) Making SOAP Requests using the REST API

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.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Rest
integer li_BTls
integer li_Port
integer li_BAutoReconnect
integer li_Success
oleobject loo_SoapXml
string ls_ResponseXml
oleobject loo_Xml

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

loo_Rest = create oleobject
// Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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).
li_BTls = 0
li_Port = 80
li_BAutoReconnect = 1
// In this particular case, it is important to connect to "wsf.cdyne.com", not "ws.cdyne.com"...
li_Success = loo_Rest.Connect("wsf.cdyne.com",li_Port,li_BTls,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    return
end if

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

// Build the SOAP XML request body.
loo_SoapXml = create oleobject
// Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
li_rc = loo_SoapXml.ConnectToNewObject("Chilkat.Xml")

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

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

Write-Debug loo_SoapXml.GetXml()

// Send the SOAP request
ls_ResponseXml = loo_Rest.FullRequestString("POST","/WeatherWS/Weather.asmx",loo_SoapXml.GetXml())
if loo_Rest.LastMethodSuccess <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_SoapXml
    return
end if

// When successful, the response status code will equal 200.
if loo_Rest.ResponseStatusCode <> 200 then
    // Examine the request/response to see what happened.
    Write-Debug "response status code = " + string(loo_Rest.ResponseStatusCode)
    Write-Debug "response status text = " + loo_Rest.ResponseStatusText
    Write-Debug "response header: " + loo_Rest.ResponseHeader
    Write-Debug "response body (if any): " + ls_ResponseXml
    Write-Debug "---"
    Write-Debug "LastRequestStartLine: " + loo_Rest.LastRequestStartLine
    Write-Debug "LastRequestHeader: " + loo_Rest.LastRequestHeader
    destroy loo_Rest
    destroy loo_SoapXml
    return
end if

loo_Xml = create oleobject
// Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
li_rc = loo_Xml.ConnectToNewObject("Chilkat.Xml")

li_Success = loo_Xml.LoadXml(ls_ResponseXml)

// GetXml will emit XML that is nicely indented for human viewing..
Write-Debug loo_Xml.GetXml()

// A sample response XML is shown below...

// To get some information, use ChilkatPath.  For example...
Write-Debug "Temperature: " + loo_Xml.ChilkatPath("soap:Body|GetCityWeatherByZIPResponse|GetCityWeatherByZIPResult|Temperature|*")

Write-Debug "Success."

// <?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>


destroy loo_Rest
destroy loo_SoapXml
destroy loo_Xml