(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Http
oleobject loo_JsonToken
integer li_Success
oleobject loo_Bd1
oleobject loo_Json
oleobject loo_SbJson
string ls_Url
oleobject loo_Resp
oleobject loo_JResp
integer li_RespStatusCode
string ls_DocumentId
string ls_DocumentIdGuid
string ls_Name
string ls_V_type
string ls_Uri
string ls_Order
string ls_ContainsPdfFormFields
string ls_TemplateRequired
string ls_AuthoritativeCopy
string ls_EnvelopeId
integer i
integer li_Count_i

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Load a previously obtained OAuth2 access token.
loo_JsonToken = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")

li_Success = loo_JsonToken.LoadFile("qa_data/tokens/docusign.json")
if li_Success = 0 then
    Write-Debug loo_JsonToken.LastErrorText
    destroy loo_Http
    destroy loo_JsonToken
    return
end if

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

loo_Bd1 = create oleobject
// Use "Chilkat_9_5_0.BinData" for versions of Chilkat < 10.0.0
li_rc = loo_Bd1.ConnectToNewObject("Chilkat.BinData")

li_Success = loo_Bd1.LoadFile("qa_data/pdf/project_xyz.pdf")

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("documents[0].documentId","1")
loo_Json.UpdateString("documents[0].name","project_xyz.pdf")
loo_Json.UpdateString("documents[0].pages","1")
loo_Json.UpdateString("documents[0].documentBase64",loo_Bd1.GetEncoded("base64"))

loo_SbJson = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbJson.ConnectToNewObject("Chilkat.StringBuilder")

loo_Json.EmitCompact = 0
loo_Json.EmitSb(loo_SbJson)

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

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

ls_Url = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents"
loo_Resp = loo_Http.PTextSb("PUT",ls_Url,loo_SbJson,"utf-8","application/json",0,0)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_JsonToken
    destroy loo_Bd1
    destroy loo_Json
    destroy loo_SbJson
    return
end if

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.Load(loo_Resp.BodyStr)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

// If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_JsonToken
    destroy loo_Bd1
    destroy loo_Json
    destroy loo_SbJson
    destroy loo_JResp
    return
end if

destroy loo_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": "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

ls_EnvelopeId = loo_JResp.StringOf("envelopeId")
i = 0
li_Count_i = loo_JResp.SizeOfArray("envelopeDocuments")
do while i < li_Count_i
    loo_JResp.I = i
    ls_DocumentId = loo_JResp.StringOf("envelopeDocuments[i].documentId")
    ls_DocumentIdGuid = loo_JResp.StringOf("envelopeDocuments[i].documentIdGuid")
    ls_Name = loo_JResp.StringOf("envelopeDocuments[i].name")
    ls_V_type = loo_JResp.StringOf("envelopeDocuments[i].type")
    ls_Uri = loo_JResp.StringOf("envelopeDocuments[i].uri")
    ls_Order = loo_JResp.StringOf("envelopeDocuments[i].order")
    ls_ContainsPdfFormFields = loo_JResp.StringOf("envelopeDocuments[i].containsPdfFormFields")
    ls_TemplateRequired = loo_JResp.StringOf("envelopeDocuments[i].templateRequired")
    ls_AuthoritativeCopy = loo_JResp.StringOf("envelopeDocuments[i].authoritativeCopy")
    i = i + 1
loop


destroy loo_Http
destroy loo_JsonToken
destroy loo_Bd1
destroy loo_Json
destroy loo_SbJson
destroy loo_JResp