(Lianja) 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 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")

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

// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
loJsonToken = createobject("CkJsonObject")
// Load a previously obtained OAuth2 access token.
llSuccess = loJsonToken.LoadFile("qa_data/tokens/docusign.json")
if (llSuccess = .F.) then
    ? loJsonToken.LastErrorText
    release loHttp
    release loJsonToken
    return
endif

loHttp.AuthToken = loJsonToken.StringOf("access_token")

// Use your account ID and a valid envelopeId here:
loHttp.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
loHttp.SetUrlVar("envelopeId","90d7e40a-b4bd-4ccd-bf38-c80e37954a13")

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJsonToken
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

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

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loJsonToken
    release loSbResponseBody
    release loJResp
    return
endif

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

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")
    lcDisplay = loJResp.StringOf("envelopeDocuments[i].display")
    lcIncludeInDownload = loJResp.StringOf("envelopeDocuments[i].includeInDownload")
    lcSignerMustAcknowledge = loJResp.StringOf("envelopeDocuments[i].signerMustAcknowledge")
    lcTemplateRequired = loJResp.StringOf("envelopeDocuments[i].templateRequired")
    lcAuthoritativeCopy = loJResp.StringOf("envelopeDocuments[i].authoritativeCopy")
    j = 0
    lnCount_j = loJResp.SizeOfArray("envelopeDocuments[i].pages")
    do while j < lnCount_j
        loJResp.J = j
        lcPageId = loJResp.StringOf("envelopeDocuments[i].pages[j].pageId")
        lcSequence = loJResp.StringOf("envelopeDocuments[i].pages[j].sequence")
        lcHeight = loJResp.StringOf("envelopeDocuments[i].pages[j].height")
        lcWidth = loJResp.StringOf("envelopeDocuments[i].pages[j].width")
        lcDpi = loJResp.StringOf("envelopeDocuments[i].pages[j].dpi")
        j = j + 1
    enddo
    j = 0
    lnCount_j = loJResp.SizeOfArray("envelopeDocuments[i].availableDocumentTypes")
    do while j < lnCount_j
        loJResp.J = j
        lcV_type = loJResp.StringOf("envelopeDocuments[i].availableDocumentTypes[j].type")
        lcIsDefault = loJResp.StringOf("envelopeDocuments[i].availableDocumentTypes[j].isDefault")
        j = j + 1
    enddo
    i = i + 1
enddo


release loHttp
release loJsonToken
release loSbResponseBody
release loJResp