Dart Requires Chilkat v11.0.0+

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

import 'package:chilkat/chilkat.dart';

void main() {
  // 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.
  final sbXmlFileData = CkStringBuilder();
  try {
    sbXmlFileData.loadFile('qa_data/xml/AL_SR_999802_test.xml', 'utf-8');
  } on ChilkatException {
    print('Failed to load XML file.');
    return;
  }

  sbXmlFileData.encode('base64', 'utf-8');

  // Build the XMl that will be the body of the HTTP request.
  final xml = CkXml();
  xml.tag = 'soapenv:Envelope';
  xml.addAttribute('xmlns:soapenv', 'http://schemas.xmlsoap.org/soap/envelope/');
  xml.addAttribute('xmlns:tem', 'http://tempuri.org/');
  xml.addAttribute('xmlns:xsd', 'http://www.w3.org/2001/XMLSchema');
  xml.addAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance');
  xml.updateChildContent('soapenv:Header', '');
  xml.updateChildContent('soapenv:Body|tem:NewSubmission|tem:UserName', 'yourusername');
  xml.updateChildContent('soapenv:Body|tem:NewSubmission|tem:Password', 'yourpassword');
  xml.updateAttrAt('soapenv:Body|tem:NewSubmission|tem:File', true, 'xsi:type', 'xsd:base64Binary');
  xml.updateChildContent('soapenv:Body|tem:NewSubmission|tem:File', sbXmlFileData.getAsString());

  final http = CkHttp();

  http.setRequestHeader('SoapAction', 'NewSubmission');

  final sbXml = CkStringBuilder();
  xml.getXmlSb(sbXml);

  final resp = CkHttpResponse();
  try {
    http.httpSb('POST', 'https://mattest.alabama.gov/WebServices/MFET/', sbXml, 'utf-8', 'text/xml', resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('Response status code = ${resp.statusCode}');
  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:
  final xmlResult = CkXml();
  xmlResult.loadXml(resp.bodyStr);
  final sbResult = CkStringBuilder();
  sbResult.append(xmlResult.getChildContent('s:Body|NewSubmissionResponse|NewSubmissionResult'));
  sbResult.decode('base64', '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>
}