PureBasic
PureBasic
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.Chilkat PureBasic Downloads
IncludeFile "CkHttp.pb"
IncludeFile "CkXml.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
success.i = 0
; 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.
sbXmlFileData.i = CkStringBuilder::ckCreate()
If sbXmlFileData.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkStringBuilder::ckLoadFile(sbXmlFileData,"qa_data/xml/AL_SR_999802_test.xml","utf-8")
If success <> 1
Debug "Failed to load XML file."
CkStringBuilder::ckDispose(sbXmlFileData)
ProcedureReturn
EndIf
CkStringBuilder::ckEncode(sbXmlFileData,"base64","utf-8")
; Build the XMl that will be the body of the HTTP request.
xml.i = CkXml::ckCreate()
If xml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::setCkTag(xml, "soapenv:Envelope")
CkXml::ckAddAttribute(xml,"xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
CkXml::ckAddAttribute(xml,"xmlns:tem","http://tempuri.org/")
CkXml::ckAddAttribute(xml,"xmlns:xsd","http://www.w3.org/2001/XMLSchema")
CkXml::ckAddAttribute(xml,"xmlns:xsi","http://www.w3.org/2001/XMLSchema-instance")
CkXml::ckUpdateChildContent(xml,"soapenv:Header","")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|tem:NewSubmission|tem:UserName","yourusername")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|tem:NewSubmission|tem:Password","yourpassword")
CkXml::ckUpdateAttrAt(xml,"soapenv:Body|tem:NewSubmission|tem:File",1,"xsi:type","xsd:base64Binary")
CkXml::ckUpdateChildContent(xml,"soapenv:Body|tem:NewSubmission|tem:File",CkStringBuilder::ckGetAsString(sbXmlFileData))
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttp::ckSetRequestHeader(http,"SoapAction","NewSubmission")
sbXml.i = CkStringBuilder::ckCreate()
If sbXml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::ckGetXmlSb(xml,sbXml)
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpSb(http,"POST","https://mattest.alabama.gov/WebServices/MFET/",sbXml,"utf-8","text/xml",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkStringBuilder::ckDispose(sbXmlFileData)
CkXml::ckDispose(xml)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbXml)
CkHttpResponse::ckDispose(resp)
ProcedureReturn
EndIf
Debug "Response status code = " + Str(CkHttpResponse::ckStatusCode(resp))
Debug "Response body text:"
Debug CkHttpResponse::ckBodyStr(resp)
; 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:
xmlResult.i = CkXml::ckCreate()
If xmlResult.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::ckLoadXml(xmlResult,CkHttpResponse::ckBodyStr(resp))
sbResult.i = CkStringBuilder::ckCreate()
If sbResult.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckAppend(sbResult,CkXml::ckGetChildContent(xmlResult,"s:Body|NewSubmissionResponse|NewSubmissionResult"))
CkStringBuilder::ckDecode(sbResult,"base64","utf-8")
Debug "Decoded result:"
Debug CkStringBuilder::ckGetAsString(sbResult)
; 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>
CkStringBuilder::ckDispose(sbXmlFileData)
CkXml::ckDispose(xml)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbXml)
CkHttpResponse::ckDispose(resp)
CkXml::ckDispose(xmlResult)
CkStringBuilder::ckDispose(sbResult)
ProcedureReturn
EndProcedure