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.

C

#include <C_CkRest.h>
#include <C_CkXml.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkRest rest;
    BOOL bTls;
    int port;
    BOOL bAutoReconnect;
    HCkXml soapXml;
    const char *responseXml;
    HCkXml xml;

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

    rest = CkRest_Create();

    // 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).
    bTls = FALSE;
    port = 80;
    bAutoReconnect = TRUE;
    // In this particular case, it is important to connect to "wsf.cdyne.com", not "ws.cdyne.com"...
    success = CkRest_Connect(rest,"wsf.cdyne.com",port,bTls,bAutoReconnect);
    if (success != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        return;
    }

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

    // Build the SOAP XML request body.
    soapXml = CkXml_Create();

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

    CkXml_NewChild2(soapXml,"soap:Body","");
    success = CkXml_GetChild2(soapXml,0);
    CkXml_NewChild2(soapXml,"GetCityWeatherByZIP","");
    success = CkXml_GetChild2(soapXml,0);
    success = CkXml_AddAttribute(soapXml,"xmlns","http://ws.cdyne.com/WeatherWS/");
    CkXml_NewChild2(soapXml,"ZIP","60187");
    CkXml_GetRoot2(soapXml);

    printf("%s\n",CkXml_getXml(soapXml));

    // Send the SOAP request
    responseXml = CkRest_fullRequestString(rest,"POST","/WeatherWS/Weather.asmx",CkXml_getXml(soapXml));
    if (CkRest_getLastMethodSuccess(rest) != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        CkXml_Dispose(soapXml);
        return;
    }

    // When successful, the response status code will equal 200.
    if (CkRest_getResponseStatusCode(rest) != 200) {
        // Examine the request/response to see what happened.
        printf("response status code = %d\n",CkRest_getResponseStatusCode(rest));
        printf("response status text = %s\n",CkRest_responseStatusText(rest));
        printf("response header: %s\n",CkRest_responseHeader(rest));
        printf("response body (if any): %s\n",responseXml);
        printf("---\n");
        printf("LastRequestStartLine: %s\n",CkRest_lastRequestStartLine(rest));
        printf("LastRequestHeader: %s\n",CkRest_lastRequestHeader(rest));
        CkRest_Dispose(rest);
        CkXml_Dispose(soapXml);
        return;
    }

    xml = CkXml_Create();
    success = CkXml_LoadXml(xml,responseXml);

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

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

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

    printf("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>


    CkRest_Dispose(rest);
    CkXml_Dispose(soapXml);
    CkXml_Dispose(xml);

    }