Dart

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.

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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.
  // --------------------------------------------------------------------------------

  final rest = 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).
  final bTls = false;
  final port = 80;
  final bAutoReconnect = true;
  // In this particular case, it is important to connect to "wsf.cdyne.com", not "ws.cdyne.com"...
  try {
    rest.connect('wsf.cdyne.com', port, bTls, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

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

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

  soapXml.tag = 'soap:Envelope';
  soapXml.addAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
  soapXml.addAttribute('xmlns:xsd', 'http://www.w3.org/2001/XMLSchema');
  soapXml.addAttribute('xmlns:soap', 'http://schemas.xmlsoap.org/soap/envelope/');

  soapXml.newChild2('soap:Body', '');
  soapXml.getChild2(0);
  soapXml.newChild2('GetCityWeatherByZIP', '');
  soapXml.getChild2(0);
  soapXml.addAttribute('xmlns', 'http://ws.cdyne.com/WeatherWS/');
  soapXml.newChild2('ZIP', '60187');
  soapXml.getRoot2();

  print(soapXml.getXml());

  // Send the SOAP request
  final String responseXml;
  try {
    responseXml = rest.fullRequestString('POST', '/WeatherWS/Weather.asmx', soapXml.getXml());
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // When successful, the response status code will equal 200.
  if (rest.responseStatusCode != 200) {
    // Examine the request/response to see what happened.
    print('response status code = ${rest.responseStatusCode}');
    print('response status text = ${rest.responseStatusText}');
    print('response header: ${rest.responseHeader}');
    print('response body (if any): $responseXml');
    print('---');
    print('LastRequestStartLine: ${rest.lastRequestStartLine}');
    print('LastRequestHeader: ${rest.lastRequestHeader}');
    return;
  }

  final xml = CkXml();
  xml.loadXml(responseXml);

  // GetXml will emit XML that is nicely indented for human viewing..
  print(xml.getXml());

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

  // To get some information, use ChilkatPath.  For example...
  print('Temperature: ${xml.chilkatPath('soap:Body|GetCityWeatherByZIPResponse|GetCityWeatherByZIPResult|Temperature|*')}');

  print('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>
}