(VBScript) 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.

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

' Implements the following HTTP request:
' GET /restapi/v2.1/accounts/{accountId}/folders

' Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jsonToken = CreateObject("Chilkat.JsonObject")
' Load a previously obtained OAuth2 access token.
success = jsonToken.LoadFile("qa_data/tokens/docusign.json")
If (success = 0) Then
    outFile.WriteLine(jsonToken.LastErrorText)
    WScript.Quit
End If

http.AuthToken = jsonToken.StringOf("access_token")

' Use your account ID here:
success = http.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = http.QuickGetSb("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/folders",sbResponseBody)
If (success = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())

respStatusCode = http.LastStatus
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(http.LastHeader)
    outFile.WriteLine("Failed.")
    WScript.Quit
End If

' 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

resultSetSize = jResp.StringOf("resultSetSize")
startPosition = jResp.StringOf("startPosition")
endPosition = jResp.StringOf("endPosition")
totalSetSize = jResp.StringOf("totalSetSize")
i = 0
count_i = jResp.SizeOfArray("folders")
Do While i < count_i
    jResp.I = i
    name = jResp.StringOf("folders[i].name")
    v_type = jResp.StringOf("folders[i].type")
    ownerUserName = jResp.StringOf("folders[i].owner.userName")
    ownerUserId = jResp.StringOf("folders[i].owner.userId")
    ownerEmail = jResp.StringOf("folders[i].owner.email")
    folderId = jResp.StringOf("folders[i].folderId")
    uri = jResp.StringOf("folders[i].uri")
    itemCount = jResp.StringOf("folders[i].itemCount")
    subFolderCount = jResp.StringOf("folders[i].subFolderCount")
    hasSubFolders = jResp.StringOf("folders[i].hasSubFolders")
    i = i + 1
Loop

outFile.Close