Lua

DocuSign List Envelope Documents

See more DocuSign Examples

Retrieve a list of all documents within a specific envelope. Lua

local chilkat = require("chilkat")

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

local http = chilkat.Http.new()

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

-- Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
local jsonToken = chilkat.JsonObject.new()
-- Load a previously obtained OAuth2 access token.
local success = jsonToken:load_file("qa_data/tokens/docusign.json")
if not success then
    print(jsonToken.last_error_text)
    return
end

http.auth_token = jsonToken:string_of("access_token")

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

local sbResponseBody = chilkat.StringBuilder.new()
success = http:quick_get_sb("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents", sbResponseBody)
if not success then
    print(http.last_error_text)
    return
end

local jResp = chilkat.JsonObject.new()
jResp:load_sb(sbResponseBody)
jResp.emit_compact = false

print("Response Body:")
print(jResp:emit())

local respStatusCode = http.last_status
print("Response Status Code = " .. respStatusCode)
if respStatusCode >= 400 then
    print("Response Header:")
    print(http.last_header)
    print("Failed.")
    return
end

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

local documentId = ""
local documentIdGuid = ""
local name = ""
local v_type = ""
local uri = ""
local order = ""
local display = ""
local includeInDownload = ""
local signerMustAcknowledge = ""
local templateRequired = ""
local authoritativeCopy = ""
local j = 0
local count_j = 0
local pageId = ""
local sequence = ""
local height = ""
local width = ""
local dpi = ""
local isDefault = ""

local envelopeId = jResp:string_of("envelopeId")
local i = 0
local count_i = jResp:size_of_array("envelopeDocuments")
while i < count_i do
    jResp.i = i
    documentId = jResp:string_of("envelopeDocuments[i].documentId")
    documentIdGuid = jResp:string_of("envelopeDocuments[i].documentIdGuid")
    name = jResp:string_of("envelopeDocuments[i].name")
    v_type = jResp:string_of("envelopeDocuments[i].type")
    uri = jResp:string_of("envelopeDocuments[i].uri")
    order = jResp:string_of("envelopeDocuments[i].order")
    display = jResp:string_of("envelopeDocuments[i].display")
    includeInDownload = jResp:string_of("envelopeDocuments[i].includeInDownload")
    signerMustAcknowledge = jResp:string_of("envelopeDocuments[i].signerMustAcknowledge")
    templateRequired = jResp:string_of("envelopeDocuments[i].templateRequired")
    authoritativeCopy = jResp:string_of("envelopeDocuments[i].authoritativeCopy")
    j = 0
    count_j = jResp:size_of_array("envelopeDocuments[i].pages")
    while j < count_j do
        jResp.j = j
        pageId = jResp:string_of("envelopeDocuments[i].pages[j].pageId")
        sequence = jResp:string_of("envelopeDocuments[i].pages[j].sequence")
        height = jResp:string_of("envelopeDocuments[i].pages[j].height")
        width = jResp:string_of("envelopeDocuments[i].pages[j].width")
        dpi = jResp:string_of("envelopeDocuments[i].pages[j].dpi")
        j = j + 1
    end

    j = 0
    count_j = jResp:size_of_array("envelopeDocuments[i].availableDocumentTypes")
    while j < count_j do
        jResp.j = j
        v_type = jResp:string_of("envelopeDocuments[i].availableDocumentTypes[j].type")
        isDefault = jResp:string_of("envelopeDocuments[i].availableDocumentTypes[j].isDefault")
        j = j + 1
    end

    i = i + 1
end