Swift

Alabama Motor Fuel Excise Tax E-Filing SOAP XML POST (NewSubmission)

See more HTTP Misc Examples

Demonstrates how to post a NewSubmission to the Alabama MFET (Motor Fuel Excise Tax) e-File. Swift

func chilkatTest() {
    var success: Bool = false

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

    // Here is an example of an HTTP POST Request we'll be sending:

    // POST /WebServices/MFET/ HTTP/1.1
    // Content-Type: text/xml
    // SOAPAction: NewSubmission
    //  
    // <soapenv:Envelope
    //   xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    //   xmlns:tem="http://tempuri.org/"
    //   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    //   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    //   <soapenv:Header/>
    //   <soapenv:Body>
    //     <tem:NewSubmission>
    //       <tem:UserName>yourusername</tem:UserName>
    //       <tem:Password>yourpassword</tem:Password>
    //       <tem:File xsi:type="xsd:base64Binary">TRANSMISSION_XML_FILE_CONTENTS_AS_BASE64</tem:File>
    //     </tem:NewSubmission>
    //   </soapenv:Body>
    // </soapenv:Envelope>

    // In the above XML, the "TRANSMISSION_XML_FILE_CONTENTS_AS_BASE64" contains the base64 encoded
    // string of the XML file that contains "<Transmission> ... </Transmission>"
    // First let's load the transmission XML file and get the contents as base64.
    let sbXmlFileData = CkoStringBuilder()!
    success = sbXmlFileData.loadFile(path: "qa_data/xml/AL_SR_999802_test.xml", charset: "utf-8")
    if success != true {
        print("Failed to load XML file.")
        return
    }

    sbXmlFileData.encode(encoding: "base64", charset: "utf-8")

    // Build the XMl that will be the body of the HTTP request.
    let xml = CkoXml()!
    xml.tag = "soapenv:Envelope"
    xml.addAttribute(name: "xmlns:soapenv", value: "http://schemas.xmlsoap.org/soap/envelope/")
    xml.addAttribute(name: "xmlns:tem", value: "http://tempuri.org/")
    xml.addAttribute(name: "xmlns:xsd", value: "http://www.w3.org/2001/XMLSchema")
    xml.addAttribute(name: "xmlns:xsi", value: "http://www.w3.org/2001/XMLSchema-instance")
    xml.updateChildContent(tagPath: "soapenv:Header", value: "")
    xml.updateChildContent(tagPath: "soapenv:Body|tem:NewSubmission|tem:UserName", value: "yourusername")
    xml.updateChildContent(tagPath: "soapenv:Body|tem:NewSubmission|tem:Password", value: "yourpassword")
    xml.updateAttrAt(tagPath: "soapenv:Body|tem:NewSubmission|tem:File", autoCreate: true, attrName: "xsi:type", attrValue: "xsd:base64Binary")
    xml.updateChildContent(tagPath: "soapenv:Body|tem:NewSubmission|tem:File", value: sbXmlFileData.getAsString())

    let http = CkoHttp()!

    http.setRequestHeader(name: "SoapAction", value: "NewSubmission")

    let sbXml = CkoStringBuilder()!
    xml.getSb(sb: sbXml)

    let resp = CkoHttpResponse()!
    success = http.httpSb(verb: "POST", url: "https://mattest.alabama.gov/WebServices/MFET/", sb: sbXml, charset: "utf-8", contentType: "text/xml", response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("Response status code = \(resp.statusCode.intValue)")
    print("Response body text:")
    print("\(resp.bodyStr!)")

    // The response will look like this:

    // <?xml version="1.0" encoding="utf-8" ?>
    // <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    //     <s:Body>
    //         <NewSubmissionResponse xmlns="http://tempuri.org/">
    //             <NewSubmissionResult i:type="a:base64Binary" xmlns:a="http://www.w3.org/2001/XMLSchema" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">BASE64_RESULT</NewSubmissionResult>
    //         </NewSubmissionResponse>
    //     </s:Body>
    // </s:Envelope>

    // We can get the base64 result like this:
    let xmlResult = CkoXml()!
    xmlResult.load(xmlData: resp.bodyStr)
    let sbResult = CkoStringBuilder()!
    sbResult.append(value: xmlResult.getChildContent(tagPath: "s:Body|NewSubmissionResponse|NewSubmissionResult"))
    sbResult.decode(encoding: "base64", charset: "utf-8")
    print("Decoded result:")
    print("\(sbResult.getAsString()!)")

    // A sample of a decoded error response:

    // <?xml version="1.0" encoding="utf-8"?>
    // <!--ADOR Acknowledgement 1-->
    // <Transmission xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.irs.gov/efile">
    //   <Jurisdiction>ALABAMA</Jurisdiction>
    //   <TransmissionId>2018-09-1019:14R000000001</TransmissionId>
    //   <Timestamp>2018-09-10T19:14:12Z</Timestamp>
    //   <Transmitter>
    //     <ETIN>00000</ETIN>
    //   </Transmitter>
    //   <ProcessType>P</ProcessType>
    //   <AgentIdentifier>ACK</AgentIdentifier>
    //   <AcknowledgementID>0</AcknowledgementID>
    //   <AcknowledgementTimeStamp>2018-09-11T21:16:34-05:00</AcknowledgementTimeStamp>
    //   <Errors>
    //     <Error>Process Type must be 'T' when submitted to Testing Web Service</Error>
    //   </Errors>
    // </Transmission>

}