Android™

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.

Android™

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

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

    CkRest rest = new 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).
    boolean bTls = false;
    int port = 80;
    boolean bAutoReconnect = true;
    //  In this particular case, it is important to connect to "wsf.cdyne.com", not "ws.cdyne.com"...
    success = rest.Connect("wsf.cdyne.com",port,bTls,bAutoReconnect);
    if (success != true) {
        Log.i(TAG, rest.lastErrorText());
        return;
        }

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

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

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

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

    Log.i(TAG, soapXml.getXml());

    //  Send the SOAP request
    String responseXml = rest.fullRequestString("POST","/WeatherWS/Weather.asmx",soapXml.getXml());
    if (rest.get_LastMethodSuccess() != true) {
        Log.i(TAG, 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.
        Log.i(TAG, "response status code = " + String.valueOf(rest.get_ResponseStatusCode()));
        Log.i(TAG, "response status text = " + rest.responseStatusText());
        Log.i(TAG, "response header: " + rest.responseHeader());
        Log.i(TAG, "response body (if any): " + responseXml);
        Log.i(TAG, "---");
        Log.i(TAG, "LastRequestStartLine: " + rest.lastRequestStartLine());
        Log.i(TAG, "LastRequestHeader: " + rest.lastRequestHeader());
        return;
        }

    CkXml xml = new CkXml();
    success = xml.LoadXml(responseXml);

    //  GetXml will emit XML that is nicely indented for human viewing..
    Log.i(TAG, xml.getXml());

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

    //  To get some information, use ChilkatPath.  For example...
    Log.i(TAG, "Temperature: " + xml.chilkatPath("soap:Body|GetCityWeatherByZIPResponse|GetCityWeatherByZIPResult|Temperature|*"));

    Log.i(TAG, "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>

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}