SQL Server

HTTP POST and Stream Response to File

See more REST Examples

Demonstrates how to send an HTTP POST and stream the response body directly to a file. SQL Server

-- 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
    DECLARE @iTmp1 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @rest int
    EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @url int
    EXEC @hr = sp_OACreate 'Chilkat.Url', @url OUT

    -- This URL will emit a response that echos the query params (name and age)
    EXEC sp_OAMethod @url, 'ParseUrl', @success OUT, 'https://www.chilkatsoft.com/readPost.asp'

    -- Connect to the web server
    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1
    EXEC sp_OAGetProperty @url, 'Host', @sTmp0 OUT
    EXEC sp_OAGetProperty @url, 'Port', @iTmp0 OUT
    EXEC sp_OAGetProperty @url, 'Ssl', @iTmp1 OUT
    EXEC sp_OAMethod @rest, 'Connect', @success OUT, @sTmp0, @iTmp0, @iTmp1, @bAutoReconnect
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @url
        RETURN
      END

    EXEC sp_OAMethod @rest, 'AddQueryParam', @success OUT, 'name', 'John'
    EXEC sp_OAMethod @rest, 'AddQueryParam', @success OUT, 'age', '33'

    --  Send the HTTP POST.
    EXEC sp_OAGetProperty @url, 'Path', @sTmp0 OUT
    EXEC sp_OAMethod @rest, 'SendReqFormUrlEncoded', @success OUT, 'POST', @sTmp0
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @url
        RETURN
      END

    -- Read the response header.
    DECLARE @responseStatusCode int
    EXEC sp_OAMethod @rest, 'ReadResponseHeader', @responseStatusCode OUT
    IF @responseStatusCode < 0
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @url
        RETURN
      END


    PRINT 'Response status code = ' + @responseStatusCode

    -- We expect a 200 response status if the file data is coming.
    -- Otherwise, we'll get a string response body with an error message(or no response body).
    IF @responseStatusCode = 200
      BEGIN

        DECLARE @bodyStream int
        EXEC @hr = sp_OACreate 'Chilkat.Stream', @bodyStream OUT

        -- The stream's sink will be a file.
        EXEC sp_OASetProperty @bodyStream, 'SinkFile', 'qa_output/out.txt'

        -- Read the response body to the stream.  Given that we've
        -- set the stream's sink to a file, it will stream directly
        -- to the file.
        EXEC sp_OAMethod @rest, 'ReadRespBodyStream', @success OUT, @bodyStream, 1
        IF @success <> 1
          BEGIN
            EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
            PRINT @sTmp0
            EXEC @hr = sp_OADestroy @rest
            EXEC @hr = sp_OADestroy @url
            EXEC @hr = sp_OADestroy @bodyStream
            RETURN
          END


        PRINT 'Successfully streamed the response to a file.'

      END
    ELSE
      BEGIN
        DECLARE @errResponse nvarchar(4000)
        EXEC sp_OAMethod @rest, 'ReadRespBodyString', @errResponse OUT
        EXEC sp_OAGetProperty @rest, 'LastMethodSuccess', @iTmp0 OUT
        IF @iTmp0 <> 1
          BEGIN
            EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
            PRINT @sTmp0
          END
        ELSE
          BEGIN

            PRINT @errResponse
          END
      END

    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @url
    EXEC @hr = sp_OADestroy @bodyStream


END
GO