(PowerBuilder) 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

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_JsonToken
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Name
string ls_V_type
string ls_OwnerUserName
string ls_OwnerUserId
string ls_OwnerEmail
string ls_FolderId
string ls_Uri
string ls_ItemCount
string ls_SubFolderCount
string ls_HasSubFolders
string ls_ResultSetSize
string ls_StartPosition
string ls_EndPosition
string ls_TotalSetSize
integer i
integer li_Count_i

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
loo_JsonToken = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")

// Load a previously obtained OAuth2 access token.
li_Success = loo_JsonToken.LoadFile("qa_data/tokens/docusign.json")
if li_Success = 0 then
    Write-Debug loo_JsonToken.LastErrorText
    destroy loo_Http
    destroy loo_JsonToken
    return
end if

loo_Http.AuthToken = loo_JsonToken.StringOf("access_token")

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

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/folders",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_JsonToken
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_JsonToken
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
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

ls_ResultSetSize = loo_JResp.StringOf("resultSetSize")
ls_StartPosition = loo_JResp.StringOf("startPosition")
ls_EndPosition = loo_JResp.StringOf("endPosition")
ls_TotalSetSize = loo_JResp.StringOf("totalSetSize")
i = 0
li_Count_i = loo_JResp.SizeOfArray("folders")
do while i < li_Count_i
    loo_JResp.I = i
    ls_Name = loo_JResp.StringOf("folders[i].name")
    ls_V_type = loo_JResp.StringOf("folders[i].type")
    ls_OwnerUserName = loo_JResp.StringOf("folders[i].owner.userName")
    ls_OwnerUserId = loo_JResp.StringOf("folders[i].owner.userId")
    ls_OwnerEmail = loo_JResp.StringOf("folders[i].owner.email")
    ls_FolderId = loo_JResp.StringOf("folders[i].folderId")
    ls_Uri = loo_JResp.StringOf("folders[i].uri")
    ls_ItemCount = loo_JResp.StringOf("folders[i].itemCount")
    ls_SubFolderCount = loo_JResp.StringOf("folders[i].subFolderCount")
    ls_HasSubFolders = loo_JResp.StringOf("folders[i].hasSubFolders")
    i = i + 1
loop


destroy loo_Http
destroy loo_JsonToken
destroy loo_SbResponseBody
destroy loo_JResp