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

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- 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.
    -- --------------------------------------------------------------------------------

    DECLARE @success int

    -- 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.
    DECLARE @sbXml int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbXml OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OAMethod @sbXml, 'LoadFile', @success OUT, 'qa_data/xml/AL_SR_999802_test.xml', 'utf-8'
    IF @success <> 1
      BEGIN

        PRINT 'Failed to load XML file.'
        EXEC @hr = sp_OADestroy @sbXml
        RETURN
      END
    EXEC sp_OAMethod @sbXml, 'Encode', @success OUT, 'base64', 'utf-8'

    -- Build the XMl that will be the body of the HTTP request.
    DECLARE @xml int
    -- Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Xml', @xml OUT

    EXEC sp_OASetProperty @xml, 'Tag', 'soapenv:Envelope'
    EXEC sp_OAMethod @xml, 'AddAttribute', @success OUT, 'xmlns:soapenv', 'http://schemas.xmlsoap.org/soap/envelope/'
    EXEC sp_OAMethod @xml, 'AddAttribute', @success OUT, 'xmlns:tem', 'http://tempuri.org/'
    EXEC sp_OAMethod @xml, 'AddAttribute', @success OUT, 'xmlns:xsd', 'http://www.w3.org/2001/XMLSchema'
    EXEC sp_OAMethod @xml, 'AddAttribute', @success OUT, 'xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Header', ''
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|tem:NewSubmission|tem:UserName', 'yourusername'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|tem:NewSubmission|tem:Password', 'yourpassword'
    EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'soapenv:Body|tem:NewSubmission|tem:File', 1, 'xsi:type', 'xsd:base64Binary'
    EXEC sp_OAMethod @sbXml, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'soapenv:Body|tem:NewSubmission|tem:File', @sTmp0

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'text/xml'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'SoapAction', 'NewSubmission'

    DECLARE @resp int
    EXEC sp_OAMethod @xml, 'GetXml', @sTmp0 OUT
    EXEC sp_OAMethod @http, 'PostXml', @resp OUT, 'https://mattest.alabama.gov/WebServices/MFET/', @sTmp0, 'utf-8'
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sbXml
        EXEC @hr = sp_OADestroy @xml
        EXEC @hr = sp_OADestroy @http
        RETURN
      END


    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT 'Response status code = ' + @iTmp0

    PRINT 'Response body text:'
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0

    -- 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:
    DECLARE @xmlResult int
    -- Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Xml', @xmlResult OUT

    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @xmlResult, 'LoadXml', @success OUT, @sTmp0
    DECLARE @sbResult int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResult OUT

    EXEC sp_OAMethod @xmlResult, 'GetChildContent', @sTmp0 OUT, 's:Body|NewSubmissionResponse|NewSubmissionResult'
    EXEC sp_OAMethod @sbResult, 'Append', @success OUT, @sTmp0
    EXEC sp_OAMethod @sbResult, 'Decode', @success OUT, 'base64', 'utf-8'

    PRINT 'Decoded result:'
    EXEC sp_OAMethod @sbResult, 'GetAsString', @sTmp0 OUT
    PRINT @sTmp0

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

    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @sbXml
    EXEC @hr = sp_OADestroy @xml
    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @xmlResult
    EXEC @hr = sp_OADestroy @sbResult


END
GO