Xbase++
Xbase++
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.Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oHttp
LOCAL oJsonToken
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL cName
LOCAL cV_type
LOCAL cOwnerUserName
LOCAL cOwnerUserId
LOCAL cOwnerEmail
LOCAL cFolderId
LOCAL cUri
LOCAL cItemCount
LOCAL cSubFolderCount
LOCAL cHasSubFolders
LOCAL cResultSetSize
LOCAL cStartPosition
LOCAL cEndPosition
LOCAL cTotalSetSize
LOCAL i
LOCAL nCount_i
nSuccess := 0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
oHttp := CreateObject("Chilkat.Http")
// Implements the following HTTP request:
// GET /restapi/v2.1/accounts/{accountId}/folders
// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
oJsonToken := CreateObject("Chilkat.JsonObject")
// Load a previously obtained OAuth2 access token.
nSuccess := oJsonToken:LoadFile("qa_data/tokens/docusign.json")
IF (nSuccess == 0)
? oJsonToken:LastErrorText
oHttp:destroy()
oJsonToken:destroy()
RETURN
ENDIF
oHttp:AuthToken := oJsonToken:StringOf("access_token")
// Use your account ID here:
oHttp:SetUrlVar("accountId", "7f3f65ed-5e87-418d-94c1-92499ddc8252")
oSbResponseBody := CreateObject("Chilkat.StringBuilder")
nSuccess := oHttp:QuickGetSb("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/folders", oSbResponseBody)
IF (nSuccess == 0)
? oHttp:LastErrorText
oHttp:destroy()
oJsonToken:destroy()
oSbResponseBody:destroy()
RETURN
ENDIF
oJResp := CreateObject("Chilkat.JsonObject")
oJResp:LoadSb(oSbResponseBody)
oJResp:EmitCompact := 0
? "Response Body:"
? oJResp:Emit()
nRespStatusCode := oHttp:LastStatus
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode >= 400)
? "Response Header:"
? oHttp:LastHeader
? "Failed."
oHttp:destroy()
oJsonToken:destroy()
oSbResponseBody:destroy()
oJResp:destroy()
RETURN
ENDIF
// 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
cResultSetSize := oJResp:StringOf("resultSetSize")
cStartPosition := oJResp:StringOf("startPosition")
cEndPosition := oJResp:StringOf("endPosition")
cTotalSetSize := oJResp:StringOf("totalSetSize")
i := 0
nCount_i := oJResp:SizeOfArray("folders")
DO WHILE i < nCount_i
oJResp:I := i
cName := oJResp:StringOf("folders[i].name")
cV_type := oJResp:StringOf("folders[i].type")
cOwnerUserName := oJResp:StringOf("folders[i].owner.userName")
cOwnerUserId := oJResp:StringOf("folders[i].owner.userId")
cOwnerEmail := oJResp:StringOf("folders[i].owner.email")
cFolderId := oJResp:StringOf("folders[i].folderId")
cUri := oJResp:StringOf("folders[i].uri")
cItemCount := oJResp:StringOf("folders[i].itemCount")
cSubFolderCount := oJResp:StringOf("folders[i].subFolderCount")
cHasSubFolders := oJResp:StringOf("folders[i].hasSubFolders")
i := i + 1
ENDDO
oHttp:destroy()
oJsonToken:destroy()
oSbResponseBody:destroy()
oJResp:destroy()