B4X

DocuSign Add One Document to a Draft Envelope

See more DocuSign Examples

Demonstrates how to add one document to a DocuSign draft envelope. B4X

Dim success As Boolean = False

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

Dim http As ChilkatHttp
http.Initialize("http")

'  Load a previously obtained OAuth2 access token.
Dim jsonToken As ChilkatJsonObject
jsonToken.Initialize
success = jsonToken.LoadFile("qa_data/tokens/docusign.json")
If success = False Then
    Log(jsonToken.LastErrorText)
    Return
End If


'  Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
http.AuthToken = jsonToken.StringOf("access_token")

'  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": "project_xyz.pdf",
'  		"pages": "1",
'  		"documentBase64": "<insert base64 content here>"
'  		}
'  	]
'  }

Dim bd1 As ChilkatBinData
bd1.Initialize
success = bd1.LoadFile("qa_data/pdf/project_xyz.pdf")

Dim json As ChilkatJsonObject
json.Initialize
json.UpdateString("documents[0].documentId", "1")
json.UpdateString("documents[0].name", "project_xyz.pdf")
json.UpdateString("documents[0].pages", "1")
json.UpdateString("documents[0].documentBase64", bd1.GetEncoded("base64"))

Dim sbJson As ChilkatStringBuilder
sbJson.Initialize
json.EmitCompact = False
json.EmitSb(sbJson)

http.SetRequestHeader("Expect", "100-continue")
http.SetRequestHeader("Cache-Control", "no-cache")
http.SetRequestHeader("Accept", "application/json")

'  Use your own account ID here.
http.SetUrlVar("accountId", "7f3f65ed-5e87-418d-94c1-92499ddc8252")
'  Use the envelope ID returned by DocuSign when creating the draft envelope).
http.SetUrlVar("envelopeId", "cee4191c-f94e-4089-9d7c-8033685cbc1a")

Dim url As String = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents"
Dim resp As ChilkatHttpResponse
resp.Initialize
success = http.HttpSb("PUT", url, sbJson, "utf-8", "application/json", resp)
If success = False Then
    Log(http.LastErrorText)
    Return
End If


Dim jResp As ChilkatJsonObject
jResp.Initialize
jResp.Load(resp.BodyStr)
jResp.EmitCompact = False

Log("Response Body:")
Log(jResp.Emit)

'  If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
Dim respStatusCode As Int = resp.StatusCode
Log("Response Status Code = " & respStatusCode)
If respStatusCode >= 400 Then
    Log("Response Header:")
    Log(resp.Header)
    Log("Failed.")
    Return
End If


'  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": "project_xyz.pdf",
'        "type": "content",
'        "uri": "/envelopes/da9fb811-e6a4-48c0-a9fb-81ed18b989af/documents/1",
'        "order": "3",
'        "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

Dim documentId As String
Dim documentIdGuid As String
Dim name As String
Dim v_type As String
Dim uri As String
Dim order As String
Dim containsPdfFormFields As String
Dim templateRequired As String
Dim authoritativeCopy As String

Dim envelopeId As String = jResp.StringOf("envelopeId")
Dim i As Int = 0
Dim count_i As Int = jResp.SizeOfArray("envelopeDocuments")
Do While i < count_i
    jResp.I = i
    documentId = jResp.StringOf("envelopeDocuments[i].documentId")
    documentIdGuid = jResp.StringOf("envelopeDocuments[i].documentIdGuid")
    name = jResp.StringOf("envelopeDocuments[i].name")
    v_type = jResp.StringOf("envelopeDocuments[i].type")
    uri = jResp.StringOf("envelopeDocuments[i].uri")
    order = jResp.StringOf("envelopeDocuments[i].order")
    containsPdfFormFields = jResp.StringOf("envelopeDocuments[i].containsPdfFormFields")
    templateRequired = jResp.StringOf("envelopeDocuments[i].templateRequired")
    authoritativeCopy = jResp.StringOf("envelopeDocuments[i].authoritativeCopy")
    i = i + 1
Loop