(SQL Server) HttpPostJson2Async Example

Demonstrates use of the HttpPostJson2Async method.

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 requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code

    -- See PostJson2 Example for the synchronous equivalent of this example.

    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 @success int

    -- Sends a POST equivalent to the following CURL command:

    -- curl -X POST https://sandbox.plaid.com/institutions/get \
    --   -H 'content-type: application/json' \
    --   -d '{
    --     "client_id": String,
    --     "secret":String,
    --     "count": Number,
    --     "offset": Number
    --   }'

    -- Suppress some default headers that would automatically added..
    EXEC sp_OASetProperty @http, 'AcceptCharset', ''
    EXEC sp_OASetProperty @http, 'UserAgent', ''
    EXEC sp_OASetProperty @http, 'AcceptLanguage', ''
    EXEC sp_OASetProperty @http, 'AllowGzip', 0

    DECLARE @jsonBody nvarchar(4000)
    SELECT @jsonBody = '{"client_id": "PLAID_CLIENT_ID", "secret":"PLAID_SECRET", "count": 10, "offset": 0}'
    DECLARE @task int
    EXEC sp_OAMethod @http, 'PostJson2Async', @task OUT, 'https://sandbox.plaid.com/institutions/get', 'application/json', @jsonBody
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    -- Start the background task.
    EXEC sp_OAMethod @task, 'Run', @success OUT
    IF Not @success
      BEGIN
        EXEC sp_OAGetProperty @task, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @task

        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    -- The application is now free to do anything else
    -- while the HTTP POST is in progress

    -- For this example, we'll simply sleep and periodically
    -- check to see if the HTTP POST is finished.  
    EXEC sp_OAGetProperty @task, 'Finished', @iTmp0 OUT
    WHILE @iTmp0 <> 1
      BEGIN
        -- Sleep 100 ms.
        EXEC sp_OAMethod @task, 'SleepMs', NULL, 100
      END

    -- When we get here, the task is either finished successfully or not, or was canceled/aborted.

    -- If the task was "canceled", it was canceled prior to actually starting.  This could
    -- happen if the task was canceled while waiting in a thread pool queue to be scheduled by Chilkat's
    -- background thread pool scheduler.  

    -- If the task was "aborted", it indicates that it was canceled while running in a background thread.  
    -- The ResultErrorText will likely indicate that the task was aborted.

    -- If the task "completed", then it ran to completion, but the actual success/failure of the method
    -- is determined by getting the result of the underlying method call.
    -- A task status of 7 indicates completion.
    EXEC sp_OAGetProperty @task, 'StatusInt', @iTmp0 OUT
    IF @iTmp0 <> 7
      BEGIN

        PRINT 'Task did not complete.'

        EXEC sp_OAGetProperty @task, 'Status', @sTmp0 OUT
        PRINT 'task status: ' + @sTmp0
        EXEC @hr = sp_OADestroy @task

        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    -- When called synchronously, the PostJson2 method returns an HTTP response object,
    -- unless the method failed and there was no response to be had.
    -- Check to see if PostJson2 method failed (and thus there is no response object).
    EXEC sp_OAGetProperty @task, 'TaskSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN

        PRINT 'The underlying task failed, and there is no HTTP response object.'

        PRINT 'The LastErrorText for the underlying method call is:'
        EXEC sp_OAGetProperty @task, 'ResultErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @task

        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    -- To get the HTTP response object, create a new instance and load it with the result from the task.
    DECLARE @resp int
    -- Use "Chilkat_9_5_0.HttpResponse" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT

    EXEC sp_OAMethod @resp, 'LoadTaskResult', @success OUT, @task
    EXEC @hr = sp_OADestroy @task

    DECLARE @statusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @statusCode OUT

    PRINT 'Response status code = ' + @statusCode

    -- Examine the JSON response..
    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @json, 'Load', @success OUT, @sTmp0
    EXEC sp_OASetProperty @json, 'EmitCompact', 0

    PRINT 'JSON Response Body:'
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @resp
    EXEC @hr = sp_OADestroy @json


END
GO