(Lianja) DocuSign Add One Document to a Draft Envelope

See more DocuSign Examples

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

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("CkHttp")

// Load a previously obtained OAuth2 access token.
loJsonToken = createobject("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/docusign.json")
if (llSuccess = .F.) then
    ? loJsonToken.LastErrorText
    release loHttp
    release loJsonToken
    return
endif

// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
loHttp.AuthToken = loJsonToken.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>"
// 		}
// 	]
// }

loBd1 = createobject("CkBinData")
llSuccess = loBd1.LoadFile("qa_data/pdf/project_xyz.pdf")

loJson = createobject("CkJsonObject")
loJson.UpdateString("documents[0].documentId","1")
loJson.UpdateString("documents[0].name","project_xyz.pdf")
loJson.UpdateString("documents[0].pages","1")
loJson.UpdateString("documents[0].documentBase64",loBd1.GetEncoded("base64"))

loSbJson = createobject("CkStringBuilder")
loJson.EmitCompact = .F.
loJson.EmitSb(loSbJson)

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

// Use your own account ID here.
loHttp.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
// Use the envelope ID returned by DocuSign when creating the draft envelope).
loHttp.SetUrlVar("envelopeId","0b437b95-cc50-475f-8dec-65bae9f27d09")

lcUrl = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents"
loResp = loHttp.PTextSb("PUT",lcUrl,loSbJson,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJsonToken
    release loBd1
    release loJson
    release loSbJson
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.Load(loResp.BodyStr)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

// If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loJsonToken
    release loBd1
    release loJson
    release loSbJson
    release loJResp
    return
endif

release loResp

// 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

lcEnvelopeId = loJResp.StringOf("envelopeId")
i = 0
lnCount_i = loJResp.SizeOfArray("envelopeDocuments")
do while i < lnCount_i
    loJResp.I = i
    lcDocumentId = loJResp.StringOf("envelopeDocuments[i].documentId")
    lcDocumentIdGuid = loJResp.StringOf("envelopeDocuments[i].documentIdGuid")
    lcName = loJResp.StringOf("envelopeDocuments[i].name")
    lcV_type = loJResp.StringOf("envelopeDocuments[i].type")
    lcUri = loJResp.StringOf("envelopeDocuments[i].uri")
    lcOrder = loJResp.StringOf("envelopeDocuments[i].order")
    lcContainsPdfFormFields = loJResp.StringOf("envelopeDocuments[i].containsPdfFormFields")
    lcTemplateRequired = loJResp.StringOf("envelopeDocuments[i].templateRequired")
    lcAuthoritativeCopy = loJResp.StringOf("envelopeDocuments[i].authoritativeCopy")
    i = i + 1
enddo


release loHttp
release loJsonToken
release loBd1
release loJson
release loSbJson
release loJResp