Objective-C

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. Objective-C

#import <CkoStringBuilder.h>
#import <CkoXml.h>
#import <CkoHttp.h>
#import <CkoHttpResponse.h>

BOOL success = NO;

// 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.
CkoStringBuilder *sbXmlFileData = [[CkoStringBuilder alloc] init];
success = [sbXmlFileData LoadFile: @"qa_data/xml/AL_SR_999802_test.xml" charset: @"utf-8"];
if (success != YES) {
    NSLog(@"%@",@"Failed to load XML file.");
    return;
}

[sbXmlFileData Encode: @"base64" charset: @"utf-8"];

// Build the XMl that will be the body of the HTTP request.
CkoXml *xml = [[CkoXml alloc] init];
xml.Tag = @"soapenv:Envelope";
[xml AddAttribute: @"xmlns:soapenv" value: @"http://schemas.xmlsoap.org/soap/envelope/"];
[xml AddAttribute: @"xmlns:tem" value: @"http://tempuri.org/"];
[xml AddAttribute: @"xmlns:xsd" value: @"http://www.w3.org/2001/XMLSchema"];
[xml AddAttribute: @"xmlns:xsi" value: @"http://www.w3.org/2001/XMLSchema-instance"];
[xml UpdateChildContent: @"soapenv:Header" value: @""];
[xml UpdateChildContent: @"soapenv:Body|tem:NewSubmission|tem:UserName" value: @"yourusername"];
[xml UpdateChildContent: @"soapenv:Body|tem:NewSubmission|tem:Password" value: @"yourpassword"];
[xml UpdateAttrAt: @"soapenv:Body|tem:NewSubmission|tem:File" autoCreate: YES attrName: @"xsi:type" attrValue: @"xsd:base64Binary"];
[xml UpdateChildContent: @"soapenv:Body|tem:NewSubmission|tem:File" value: [sbXmlFileData GetAsString]];

CkoHttp *http = [[CkoHttp alloc] init];

[http SetRequestHeader: @"SoapAction" value: @"NewSubmission"];

CkoStringBuilder *sbXml = [[CkoStringBuilder alloc] init];
[xml GetXmlSb: sbXml];

CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpSb: @"POST" url: @"https://mattest.alabama.gov/WebServices/MFET/" sb: sbXml charset: @"utf-8" contentType: @"text/xml" response: resp];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%@%d",@"Response status code = ",[resp.StatusCode intValue]);
NSLog(@"%@",@"Response body text:");
NSLog(@"%@",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:
CkoXml *xmlResult = [[CkoXml alloc] init];
[xmlResult LoadXml: resp.BodyStr];
CkoStringBuilder *sbResult = [[CkoStringBuilder alloc] init];
[sbResult Append: [xmlResult GetChildContent: @"s:Body|NewSubmissionResponse|NewSubmissionResult"]];
[sbResult Decode: @"base64" charset: @"utf-8"];
NSLog(@"%@",@"Decoded result:");
NSLog(@"%@",[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>