(Tcl) DocuSign List Envelope Documents

See more DocuSign Examples

Retrieve a list of all documents within a specific envelope.

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# Implements the following HTTP request:
# GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents

# Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
set jsonToken [new_CkJsonObject]

# Load a previously obtained OAuth2 access token.
set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/docusign.json"]
if {$success == 0} then {
    puts [CkJsonObject_lastErrorText $jsonToken]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    exit
}

CkHttp_put_AuthToken $http [CkJsonObject_stringOf $jsonToken "access_token"]

# Use your account ID and a valid envelopeId here:
CkHttp_SetUrlVar $http "accountId" "7f3f65ed-5e87-418d-94c1-92499ddc8252"
CkHttp_SetUrlVar $http "envelopeId" "90d7e40a-b4bd-4ccd-bf38-c80e37954a13"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

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

# {
#   "envelopeId": "90d7e40a-b4bd-4ccd-bf38-c80e37954a13",
#   "envelopeDocuments": [
#     {
#       "documentId": "1",
#       "documentIdGuid": "ca1d3cc6-9bc3-48d6-a5d8-a85d9acdcde1",
#       "name": "helloWorld.pdf",
#       "type": "content",
#       "uri": "/envelopes/90d7e40a-b4bd-4ccd-bf38-c80e37954a13/documents/1",
#       "order": "1",
#       "pages": [
#         {
#           "pageId": "fbf93a36-6b60-484d-94bd-ee3c08c0a546",
#           "sequence": "1",
#           "height": "842",
#           "width": "595",
#           "dpi": "72"
#         }
#       ],
#       "availableDocumentTypes": [
#         {
#           "type": "electronic",
#           "isDefault": "true"
#         }
#       ],
#       "display": "inline",
#       "includeInDownload": "true",
#       "signerMustAcknowledge": "no_interaction",
#       "templateRequired": "false",
#       "authoritativeCopy": "false"
#     },
#     {
#       "documentId": "certificate",
#       "documentIdGuid": "7479a5de-8d91-44a2-bc33-b76a9ba0f6e2",
#       "name": "Summary",
#       "type": "summary",
#       "uri": "/envelopes/90d7e40a-b4bd-4ccd-bf38-c80e37954a13/documents/certificate",
#       "order": "999",
#       "availableDocumentTypes": [
#         {
#           "type": "electronic",
#           "isDefault": "true"
#         }
#       ],
#       "display": "inline",
#       "includeInDownload": "true",
#       "signerMustAcknowledge": "no_interaction",
#       "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

set envelopeId [CkJsonObject_stringOf $jResp "envelopeId"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "envelopeDocuments"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set documentId [CkJsonObject_stringOf $jResp "envelopeDocuments[i].documentId"]
    set documentIdGuid [CkJsonObject_stringOf $jResp "envelopeDocuments[i].documentIdGuid"]
    set name [CkJsonObject_stringOf $jResp "envelopeDocuments[i].name"]
    set v_type [CkJsonObject_stringOf $jResp "envelopeDocuments[i].type"]
    set uri [CkJsonObject_stringOf $jResp "envelopeDocuments[i].uri"]
    set order [CkJsonObject_stringOf $jResp "envelopeDocuments[i].order"]
    set display [CkJsonObject_stringOf $jResp "envelopeDocuments[i].display"]
    set includeInDownload [CkJsonObject_stringOf $jResp "envelopeDocuments[i].includeInDownload"]
    set signerMustAcknowledge [CkJsonObject_stringOf $jResp "envelopeDocuments[i].signerMustAcknowledge"]
    set templateRequired [CkJsonObject_stringOf $jResp "envelopeDocuments[i].templateRequired"]
    set authoritativeCopy [CkJsonObject_stringOf $jResp "envelopeDocuments[i].authoritativeCopy"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "envelopeDocuments[i].pages"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set pageId [CkJsonObject_stringOf $jResp "envelopeDocuments[i].pages[j].pageId"]
        set sequence [CkJsonObject_stringOf $jResp "envelopeDocuments[i].pages[j].sequence"]
        set height [CkJsonObject_stringOf $jResp "envelopeDocuments[i].pages[j].height"]
        set width [CkJsonObject_stringOf $jResp "envelopeDocuments[i].pages[j].width"]
        set dpi [CkJsonObject_stringOf $jResp "envelopeDocuments[i].pages[j].dpi"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "envelopeDocuments[i].availableDocumentTypes"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set v_type [CkJsonObject_stringOf $jResp "envelopeDocuments[i].availableDocumentTypes[j].type"]
        set isDefault [CkJsonObject_stringOf $jResp "envelopeDocuments[i].availableDocumentTypes[j].isDefault"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $jsonToken
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp