(SQL Server) Yousign: Download Information about Previously Uploaded File

Demonstrates how to download the information (in JSON format) about a file previously uploaded.

For more information, see https://dev.yousign.com/?version=latest#26513de1-9fab-44d5-96b1-70fe3b3de7a7

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
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    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

    -- Implements the following CURL command:

    -- curl --location --request GET 'https://staging-api.yousign.com/files/{{id}}' \
    -- --header 'Authorization: Bearer YOUR_API_KEY' \
    -- --header 'Content-Type: application/json'

    -- Use the following online tool to generate HTTP code from a CURL command
    -- Convert a cURL Command to HTTP Source Code

    -- Adds the "Authorization: Bearer YOUR_API_KEY" header.
    EXEC sp_OASetProperty @http, 'AuthToken', 'YOUR_API_KEY'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'

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

    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://staging-api.yousign.com/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', @sbResponseBody
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END

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

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


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

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END

    -- Sample JSON response:
    -- (Sample code for parsing the JSON response is shown below)

    -- {
    --   "id": "/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    --   "name": "The best name for my file.pdf",
    --   "type": "signable",
    --   "contentType": "application/pdf",
    --   "description": null,
    --   "createdAt": "2018-12-07T08:10:21+01:00",
    --   "updatedAt": "2018-12-07T08:10:21+01:00",
    --   "sha256": "bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2",
    --   "metadata": [
    --   ],
    --   "workspace": "/workspaces/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    --   "creator": null,
    --   "protected": false,
    --   "position": 0,
    --   "parent": null
    -- }

    -- Sample code for parsing the JSON response...
    -- Use the following online tool to generate parsing code from sample JSON:
    -- Generate Parsing Code from JSON

    DECLARE @id nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
    DECLARE @name nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'name'
    DECLARE @v_type nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'type'
    DECLARE @contentType nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @contentType OUT, 'contentType'
    DECLARE @description nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'description'
    DECLARE @createdAt nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @createdAt OUT, 'createdAt'
    DECLARE @updatedAt nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @updatedAt OUT, 'updatedAt'
    DECLARE @sha256 nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @sha256 OUT, 'sha256'
    DECLARE @workspace nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @workspace OUT, 'workspace'
    DECLARE @creator nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @creator OUT, 'creator'
    DECLARE @v_protected int
    EXEC sp_OAMethod @jResp, 'BoolOf', @v_protected OUT, 'protected'
    DECLARE @position int
    EXEC sp_OAMethod @jResp, 'IntOf', @position OUT, 'position'
    DECLARE @parent nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @parent OUT, 'parent'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'metadata'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO