Lianja

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.

Lianja

llSuccess = .F.

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

loRest = createobject("CkRest")

// 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).
llBTls = .F.
lnPort = 80
llBAutoReconnect = .T.
// In this particular case, it is important to connect to "wsf.cdyne.com", not "ws.cdyne.com"...
llSuccess = loRest.Connect("wsf.cdyne.com",lnPort,llBTls,llBAutoReconnect)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loRest
    return
endif

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

// Build the SOAP XML request body.
loSoapXml = createobject("CkXml")

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

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

? loSoapXml.GetXml()

// Send the SOAP request
lcResponseXml = loRest.FullRequestString("POST","/WeatherWS/Weather.asmx",loSoapXml.GetXml())
if (loRest.LastMethodSuccess <> .T.) then
    ? loRest.LastErrorText
    release loRest
    release loSoapXml
    return
endif

// When successful, the response status code will equal 200.
if (loRest.ResponseStatusCode <> 200) then
    // Examine the request/response to see what happened.
    ? "response status code = " + str(loRest.ResponseStatusCode)
    ? "response status text = " + loRest.ResponseStatusText
    ? "response header: " + loRest.ResponseHeader
    ? "response body (if any): " + lcResponseXml
    ? "---"
    ? "LastRequestStartLine: " + loRest.LastRequestStartLine
    ? "LastRequestHeader: " + loRest.LastRequestHeader
    release loRest
    release loSoapXml
    return
endif

loXml = createobject("CkXml")
llSuccess = loXml.LoadXml(lcResponseXml)

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

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

// To get some information, use ChilkatPath.  For example...
? "Temperature: " + loXml.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>


release loRest
release loSoapXml
release loXml