(SQL Server) DocuSign Add Documents to a Draft Envelope

See more DocuSign Examples

Demonstrates how to add one or more additional documents to a DocuSign draft envelope.

For more information, see https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/updatelist/

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
    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
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Load a previously obtained OAuth2 access token.
    DECLARE @jsonToken int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jsonToken OUT

    DECLARE @success int
    EXEC sp_OAMethod @jsonToken, 'LoadFile', @success OUT, 'qa_data/tokens/docusign.json'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @jsonToken, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @jsonToken
        RETURN
      END

    -- Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
    EXEC sp_OAMethod @jsonToken, 'StringOf', @sTmp0 OUT, 'access_token'
    EXEC sp_OASetProperty @http, 'AuthToken', @sTmp0

    -- Send the following request.
    -- Make sure to use your own account ID (obtained from Get Docusign User Account Information)

    -- PUT https://demo.docusign.net/restapi/v2.1/accounts/<account ID>/envelopes/<envelope ID>/documents HTTP/1.1
    -- Expect: 100-continue
    -- Accept: application/json
    -- Cache-Control: no-cache
    -- Authorization: Bearer eyJ0eX...
    -- Content-Length: ...
    -- Content-Type: application/json
    -- 
    -- {
    -- 	"documents": [
    -- 		{
    -- 		"documentId": "1",
    -- 		"name": "hello.pdf",
    -- 		"pages": "1",
    -- 		"documentBase64": "<insert base64 content here>"
    -- 		},
    -- 		{
    -- 		"documentId": "2",
    -- 		"name": "hello2.pdf",
    -- 		"pages": "1",
    -- 		"documentBase64": "<insert base64 content here>"
    -- 		}
    -- 	]
    -- }

    DECLARE @bd1 int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.BinData', @bd1 OUT

    EXEC sp_OAMethod @bd1, 'LoadFile', @success OUT, 'qa_data/pdf/hello.pdf'
    DECLARE @bd2 int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.BinData', @bd2 OUT

    EXEC sp_OAMethod @bd2, 'LoadFile', @success OUT, 'qa_data/pdf/hello2.pdf'

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    DECLARE @i int
    SELECT @i = 0
    EXEC sp_OASetProperty @json, 'I', @i
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'documents[i].documentId', '1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'documents[i].name', 'hello.pdf'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'documents[i].pages', '1'
    EXEC sp_OAMethod @bd1, 'GetEncoded', @sTmp0 OUT, 'base64'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'documents[i].documentBase64', @sTmp0
    SELECT @i = @i + 1
    EXEC sp_OASetProperty @json, 'I', @i
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'documents[i].documentId', '2'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'documents[i].name', 'hello2.pdf'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'documents[i].pages', '1'
    EXEC sp_OAMethod @bd2, 'GetEncoded', @sTmp0 OUT, 'base64'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'documents[i].documentBase64', @sTmp0

    DECLARE @sbJson int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbJson OUT

    EXEC sp_OASetProperty @json, 'EmitCompact', 0
    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbJson

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Expect', '100-continue'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Cache-Control', 'no-cache'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'

    -- Use your own account ID here.
    EXEC sp_OAMethod @http, 'SetUrlVar', @success OUT, 'accountId', '7f3f65ed-5e87-418d-94c1-92499ddc8252'
    -- Use the envelope ID returned by DocuSign when creating the draft envelope).
    EXEC sp_OAMethod @http, 'SetUrlVar', @success OUT, 'envelopeId', 'e01f2043-3850-4fcb-afd1-b1726216e099'

    DECLARE @url nvarchar(4000)
    SELECT @url = 'https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents'
    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', @url, @sbJson, 'utf-8', 'application/json', 0, 0
    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
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @bd1
        EXEC @hr = sp_OADestroy @bd2
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbJson
        RETURN
      END

    DECLARE @jResp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT

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


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

    -- If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT

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

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @bd1
        EXEC @hr = sp_OADestroy @bd2
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbJson
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END
    EXEC @hr = sp_OADestroy @resp

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

    -- {
    --   "envelopeId": "da9fb811-e6a4-48c0-a9fb-81ed18b989af",
    --   "envelopeDocuments": [
    --     {
    --       "documentId": "1",
    --       "documentIdGuid": "38e919fc-0a77-4b0c-9da0-e3530f4e6fc7",
    --       "name": "hello.pdf",
    --       "type": "content",
    --       "uri": "/envelopes/da9fb811-e6a4-48c0-a9fb-81ed18b989af/documents/1",
    --       "order": "3",
    --       "containsPdfFormFields": "false",
    --       "templateRequired": "false",
    --       "authoritativeCopy": "false"
    --     },
    --     {
    --       "documentId": "2",
    --       "documentIdGuid": "2cbd0fcc-c1ca-4a3a-b8b5-fe252dd89731",
    --       "name": "hello2.pdf",
    --       "type": "content",
    --       "uri": "/envelopes/da9fb811-e6a4-48c0-a9fb-81ed18b989af/documents/2",
    --       "order": "4",
    --       "containsPdfFormFields": "false",
    --       "templateRequired": "false",
    --       "authoritativeCopy": "false"
    --     }
    --   ]
    -- }

    -- 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 @documentId nvarchar(4000)

    DECLARE @documentIdGuid nvarchar(4000)

    DECLARE @name nvarchar(4000)

    DECLARE @v_type nvarchar(4000)

    DECLARE @uri nvarchar(4000)

    DECLARE @order nvarchar(4000)

    DECLARE @containsPdfFormFields nvarchar(4000)

    DECLARE @templateRequired nvarchar(4000)

    DECLARE @authoritativeCopy nvarchar(4000)

    DECLARE @envelopeId nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @envelopeId OUT, 'envelopeId'
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'envelopeDocuments'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @documentId OUT, 'envelopeDocuments[i].documentId'
        EXEC sp_OAMethod @jResp, 'StringOf', @documentIdGuid OUT, 'envelopeDocuments[i].documentIdGuid'
        EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'envelopeDocuments[i].name'
        EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'envelopeDocuments[i].type'
        EXEC sp_OAMethod @jResp, 'StringOf', @uri OUT, 'envelopeDocuments[i].uri'
        EXEC sp_OAMethod @jResp, 'StringOf', @order OUT, 'envelopeDocuments[i].order'
        EXEC sp_OAMethod @jResp, 'StringOf', @containsPdfFormFields OUT, 'envelopeDocuments[i].containsPdfFormFields'
        EXEC sp_OAMethod @jResp, 'StringOf', @templateRequired OUT, 'envelopeDocuments[i].templateRequired'
        EXEC sp_OAMethod @jResp, 'StringOf', @authoritativeCopy OUT, 'envelopeDocuments[i].authoritativeCopy'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @jsonToken
    EXEC @hr = sp_OADestroy @bd1
    EXEC @hr = sp_OADestroy @bd2
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbJson
    EXEC @hr = sp_OADestroy @jResp


END
GO