Unicode C++

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.

Unicode C++

#include <CkRestW.h>
#include <CkXmlW.h>

void ChilkatSample(void)
    {
    bool success = 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.
    //  --------------------------------------------------------------------------------

    CkRestW 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).
    bool bTls = false;
    int port = 80;
    bool bAutoReconnect = true;
    //  In this particular case, it is important to connect to "wsf.cdyne.com", not "ws.cdyne.com"...
    success = rest.Connect(L"wsf.cdyne.com",port,bTls,bAutoReconnect);
    if (success != true) {
        wprintf(L"%s\n",rest.lastErrorText());
        return;
    }

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

    //  Build the SOAP XML request body.
    CkXmlW soapXml;

    soapXml.put_Tag(L"soap:Envelope");
    success = soapXml.AddAttribute(L"xmlns:xsi",L"http://www.w3.org/2001/XMLSchema-instance");
    success = soapXml.AddAttribute(L"xmlns:xsd",L"http://www.w3.org/2001/XMLSchema");
    success = soapXml.AddAttribute(L"xmlns:soap",L"http://schemas.xmlsoap.org/soap/envelope/");

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

    wprintf(L"%s\n",soapXml.getXml());

    //  Send the SOAP request
    const wchar_t *responseXml = rest.fullRequestString(L"POST",L"/WeatherWS/Weather.asmx",soapXml.getXml());
    if (rest.get_LastMethodSuccess() != true) {
        wprintf(L"%s\n",rest.lastErrorText());
        return;
    }

    //  When successful, the response status code will equal 200.
    if (rest.get_ResponseStatusCode() != 200) {
        //  Examine the request/response to see what happened.
        wprintf(L"response status code = %d\n",rest.get_ResponseStatusCode());
        wprintf(L"response status text = %s\n",rest.responseStatusText());
        wprintf(L"response header: %s\n",rest.responseHeader());
        wprintf(L"response body (if any): %s\n",responseXml);
        wprintf(L"---\n");
        wprintf(L"LastRequestStartLine: %s\n",rest.lastRequestStartLine());
        wprintf(L"LastRequestHeader: %s\n",rest.lastRequestHeader());
        return;
    }

    CkXmlW xml;
    success = xml.LoadXml(responseXml);

    //  GetXml will emit XML that is nicely indented for human viewing..
    wprintf(L"%s\n",xml.getXml());

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

    //  To get some information, use ChilkatPath.  For example...
    wprintf(L"Temperature: %s\n",xml.chilkatPath(L"soap:Body|GetCityWeatherByZIPResponse|GetCityWeatherByZIPResult|Temperature|*"));

    wprintf(L"Success.\n");

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