(SQL Server) Parse Multipart Binary Http Response

This example demonstrates how to parse an HTTP response that is multipart and contains a binary file, such as a .zip or .pdf.

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.

    DECLARE @success int

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

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

    -- ...
    -- Insert code here to construct some kind of HTTP request.
    -- this example is to show how to parse a particular kind of response.
    -- ...
    -- ...

    -- Send the request (whatever it may be in your case) to get the HTTP response object.
    DECLARE @resp int
    EXEC sp_OAMethod @http, 'SynchronousRequest', @resp OUT, 'www.somedomain.com', 443, 1, @req
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @req
        RETURN
      END

    -- Get the response body (which is expected to be binary)
    DECLARE @respBody int
    -- Use "Chilkat_9_5_0.BinData" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.BinData', @respBody OUT

    EXEC sp_OAMethod @resp, 'GetBodyBd', @success OUT, @respBody
    EXEC @hr = sp_OADestroy @resp

    -- For this example, the response body contains something like this:

    -- ------=_Part_21302_2029949381.1547401515443
    -- Content-Type: application/xop+xml; charset=UTF-8; type="text/xml"
    -- Content-Transfer-Encoding: 8bit
    -- Content-ID: <rootpart@ws.jboss.org>
    -- 
    -- <env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'><env:Header></env:Header><env:Body>...</env:Body></env:Envelope>
    -- ------=_Part_21302_2029949381.1547401515443
    -- Content-Type: application/octet-stream
    -- Content-Transfer-Encoding: binary
    -- Content-Id: <fileArchivio-7d302908-4d64-43d3-bf4e-79ce806d43b3@ws.jboss.org>
    -- 
    -- BINARY_CONTENT_HERE...
    -- 
    -- ------=_Part_21302_2029949381.1547401515443--
    -- 

    -- Load it into a Chilkat MIME object.
    DECLARE @mime int
    -- Use "Chilkat_9_5_0.Mime" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Mime', @mime OUT

    EXEC sp_OAMethod @mime, 'LoadMimeBd', @success OUT, @respBody
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @mime, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @req
        EXEC @hr = sp_OADestroy @respBody
        EXEC @hr = sp_OADestroy @mime
        RETURN
      END

    DECLARE @numParts int
    EXEC sp_OAGetProperty @mime, 'NumParts', @numParts OUT
    IF @numParts < 2
      BEGIN

        PRINT 'Expected multipart MIME with at least 2 sub-parts.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @req
        EXEC @hr = sp_OADestroy @respBody
        EXEC @hr = sp_OADestroy @mime
        RETURN
      END

    -- Get the 1st sub-part, which is the XML.
    DECLARE @part0 int
    EXEC sp_OAMethod @mime, 'GetPart', @part0 OUT, 0
    -- Should be OK because we checked NumParts above..
    DECLARE @xmlStr nvarchar(4000)
    EXEC sp_OAMethod @part0, 'GetBodyDecoded', @xmlStr OUT

    PRINT @xmlStr

    PRINT '----'
    EXEC @hr = sp_OADestroy @part0

    -- Save the 2nd part to a file.  (It is a .zip file in our test case..)
    DECLARE @part1 int
    EXEC sp_OAMethod @mime, 'GetPart', @part1 OUT, 1
    EXEC sp_OAMethod @part1, 'SaveBody', @success OUT, 'qa_output/attachedZip.zip'

    -- Alternatively, we could extract the binary data to a BinData and use elsewhere..
    DECLARE @zipData int
    -- Use "Chilkat_9_5_0.BinData" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.BinData', @zipData OUT

    EXEC sp_OAMethod @part1, 'GetBodyBd', @success OUT, @zipData
    EXEC sp_OAMethod @zipData, 'WriteFile', @success OUT, 'qa_output/attachedZip_again.zip'
    EXEC @hr = sp_OADestroy @part1


    PRINT 'OK.'

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @req
    EXEC @hr = sp_OADestroy @respBody
    EXEC @hr = sp_OADestroy @mime
    EXEC @hr = sp_OADestroy @zipData


END
GO