Xbase++

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.

Xbase++

LOCAL nSuccess
LOCAL oRest
LOCAL nBTls
LOCAL nPort
LOCAL nBAutoReconnect
LOCAL oSoapXml
LOCAL cResponseXml
LOCAL oXml

nSuccess := 0

//  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 := CreateObject("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).
nBTls := 0
nPort := 80
nBAutoReconnect := 1
//  In this particular case, it is important to connect to "wsf.cdyne.com", not "ws.cdyne.com"...
nSuccess := oRest:Connect("wsf.cdyne.com", nPort, nBTls, nBAutoReconnect)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oRest:destroy()
    RETURN
ENDIF

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

//  Build the SOAP XML request body.
oSoapXml := CreateObject("Chilkat.Xml")

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

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

? oSoapXml:GetXml()

//  Send the SOAP request
cResponseXml := oRest:FullRequestString("POST", "/WeatherWS/Weather.asmx", oSoapXml:GetXml())
IF (oRest:LastMethodSuccess != 1)
    ? oRest:LastErrorText
    oRest:destroy()
    oSoapXml:destroy()
    RETURN
ENDIF

//  When successful, the response status code will equal 200.
IF (oRest:ResponseStatusCode != 200)
    //  Examine the request/response to see what happened.
    ? "response status code = " + Str(oRest:ResponseStatusCode)
    ? "response status text = " + oRest:ResponseStatusText
    ? "response header: " + oRest:ResponseHeader
    ? "response body (if any): " + cResponseXml
    ? "---"
    ? "LastRequestStartLine: " + oRest:LastRequestStartLine
    ? "LastRequestHeader: " + oRest:LastRequestHeader
    oRest:destroy()
    oSoapXml:destroy()
    RETURN
ENDIF

oXml := CreateObject("Chilkat.Xml")
nSuccess := oXml:LoadXml(cResponseXml)

//  GetXml will emit XML that is nicely indented for human viewing..
? oXml:GetXml()

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

//  To get some information, use ChilkatPath.  For example...
? "Temperature: " + oXml:ChilkatPath("soap:Body|GetCityWeatherByZIPResponse|GetCityWeatherByZIPResult|Temperature|*")

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

oRest:destroy()
oSoapXml:destroy()
oXml:destroy()