Lua

DocuSign List Folders

See more DocuSign Examples

Retrieves a list of the folders for the account, including the folder hierarchy. You can specify type kinds of folders to return with the include query parameter. 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}/folders

-- 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 here:
http:set_url_var("accountId", "7f3f65ed-5e87-418d-94c1-92499ddc8252")

local sbResponseBody = chilkat.StringBuilder.new()
success = http:quick_get_sb("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/folders", 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)

-- {
--   "resultSetSize": "4",
--   "startPosition": "0",
--   "endPosition": "3",
--   "totalSetSize": "4",
--   "folders": [
--     {
--       "name": "Draft",
--       "type": "draft",
--       "owner": {
--         "userName": "Joe Sample",
--         "userId": "14602117-2430-4582-8a49-ba8766302272",
--         "email": "admin@chilkatsoft.com"
--       },
--       "folderId": "f0bc5174-610d-4d80-80d7-91037843ccdb",
--       "uri": "/folders/f0bc5174-610d-4d80-80d7-91037843ccdb",
--       "itemCount": "0",
--       "subFolderCount": "0",
--       "hasSubFolders": "false"
--     },
--     {
--       "name": "Inbox",
--       "type": "inbox",
--       "owner": {
--         "userName": "Joe Sample",
--         "userId": "14602117-2430-4582-8a49-ba8766302272",
--         "email": "admin@chilkatsoft.com"
--       },
--       "folderId": "06c97346-f7b4-46fd-a204-038287d655ec",
--       "uri": "/folders/06c97346-f7b4-46fd-a204-038287d655ec",
--       "itemCount": "1",
--       "subFolderCount": "0",
--       "hasSubFolders": "false"
--     },
--     {
--       "name": "Deleted Items",
--       "type": "recyclebin",
--       "owner": {
--         "userName": "Joe Sample",
--         "userId": "14602117-2430-4582-8a49-ba8766302272",
--         "email": "admin@chilkatsoft.com"
--       },
--       "folderId": "6df0919e-b152-49fc-a4c9-9b430a29d4f5",
--       "uri": "/folders/6df0919e-b152-49fc-a4c9-9b430a29d4f5",
--       "itemCount": "0",
--       "subFolderCount": "0",
--       "hasSubFolders": "false"
--     },
--     {
--       "name": "Sent Items",
--       "type": "sentitems",
--       "owner": {
--         "userName": "Joe Sample",
--         "userId": "14602117-2430-4582-8a49-ba8766302272",
--         "email": "admin@chilkatsoft.com"
--       },
--       "folderId": "456f3c76-b265-4453-a024-c39b1a5cb387",
--       "uri": "/folders/456f3c76-b265-4453-a024-c39b1a5cb387",
--       "itemCount": "1",
--       "subFolderCount": "0",
--       "hasSubFolders": "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 name = ""
local v_type = ""
local ownerUserName = ""
local ownerUserId = ""
local ownerEmail = ""
local folderId = ""
local uri = ""
local itemCount = ""
local subFolderCount = ""
local hasSubFolders = ""

local resultSetSize = jResp:string_of("resultSetSize")
local startPosition = jResp:string_of("startPosition")
local endPosition = jResp:string_of("endPosition")
local totalSetSize = jResp:string_of("totalSetSize")
local i = 0
local count_i = jResp:size_of_array("folders")
while i < count_i do
    jResp.i = i
    name = jResp:string_of("folders[i].name")
    v_type = jResp:string_of("folders[i].type")
    ownerUserName = jResp:string_of("folders[i].owner.userName")
    ownerUserId = jResp:string_of("folders[i].owner.userId")
    ownerEmail = jResp:string_of("folders[i].owner.email")
    folderId = jResp:string_of("folders[i].folderId")
    uri = jResp:string_of("folders[i].uri")
    itemCount = jResp:string_of("folders[i].itemCount")
    subFolderCount = jResp:string_of("folders[i].subFolderCount")
    hasSubFolders = jResp:string_of("folders[i].hasSubFolders")
    i = i + 1
end