Swift

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.

Swift

func chilkatTest() {
    var success: Bool = 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.
    // --------------------------------------------------------------------------------

    let rest = CkoRest()!

    // 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).
    var bTls: Bool = false
    var port: Int = 80
    var bAutoReconnect: Bool = true
    // In this particular case, it is important to connect to "wsf.cdyne.com", not "ws.cdyne.com"...
    success = rest.connect(hostname: "wsf.cdyne.com", port: port, tls: bTls, autoReconnect: bAutoReconnect)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

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

    // Build the SOAP XML request body.
    let soapXml = CkoXml()!

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

    soapXml.newChild2(tagPath: "soap:Body", content: "")
    success = soapXml.getChild2(index: 0)
    soapXml.newChild2(tagPath: "GetCityWeatherByZIP", content: "")
    success = soapXml.getChild2(index: 0)
    success = soapXml.addAttribute(name: "xmlns", value: "http://ws.cdyne.com/WeatherWS/")
    soapXml.newChild2(tagPath: "ZIP", content: "60187")
    soapXml.getRoot2()

    print("\(soapXml.getXml()!)")

    // Send the SOAP request
    var responseXml: String? = rest.fullRequestString(httpVerb: "POST", uriPath: "/WeatherWS/Weather.asmx", bodyText: soapXml.getXml())
    if rest.lastMethodSuccess != true {
        print("\(rest.lastErrorText!)")
        return
    }

    // When successful, the response status code will equal 200.
    if rest.responseStatusCode.intValue != 200 {
        // Examine the request/response to see what happened.
        print("response status code = \(rest.responseStatusCode.intValue)")
        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
    }

    let xml = CkoXml()!
    success = xml.load(xmlData: 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(cmd: "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>

}