(C) 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 C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject jsonToken;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *name;
    const char *v_type;
    const char *ownerUserName;
    const char *ownerUserId;
    const char *ownerEmail;
    const char *folderId;
    const char *uri;
    const char *itemCount;
    const char *subFolderCount;
    const char *hasSubFolders;
    const char *resultSetSize;
    const char *startPosition;
    const char *endPosition;
    const char *totalSetSize;
    int i;
    int count_i;

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

    http = CkHttp_Create();

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

    // Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
    jsonToken = CkJsonObject_Create();
    // Load a previously obtained OAuth2 access token.
    success = CkJsonObject_LoadFile(jsonToken,"qa_data/tokens/docusign.json");
    if (success == FALSE) {
        printf("%s\n",CkJsonObject_lastErrorText(jsonToken));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(jsonToken);
        return;
    }

    CkHttp_putAuthToken(http,CkJsonObject_stringOf(jsonToken,"access_token"));

    // Use your account ID here:
    CkHttp_SetUrlVar(http,"accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/folders",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(jsonToken);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttp_getLastStatus(http);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttp_lastHeader(http));
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(jsonToken);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
    // See this example explaining how this memory should be used: const char * functions.

    resultSetSize = CkJsonObject_stringOf(jResp,"resultSetSize");
    startPosition = CkJsonObject_stringOf(jResp,"startPosition");
    endPosition = CkJsonObject_stringOf(jResp,"endPosition");
    totalSetSize = CkJsonObject_stringOf(jResp,"totalSetSize");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"folders");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        name = CkJsonObject_stringOf(jResp,"folders[i].name");
        v_type = CkJsonObject_stringOf(jResp,"folders[i].type");
        ownerUserName = CkJsonObject_stringOf(jResp,"folders[i].owner.userName");
        ownerUserId = CkJsonObject_stringOf(jResp,"folders[i].owner.userId");
        ownerEmail = CkJsonObject_stringOf(jResp,"folders[i].owner.email");
        folderId = CkJsonObject_stringOf(jResp,"folders[i].folderId");
        uri = CkJsonObject_stringOf(jResp,"folders[i].uri");
        itemCount = CkJsonObject_stringOf(jResp,"folders[i].itemCount");
        subFolderCount = CkJsonObject_stringOf(jResp,"folders[i].subFolderCount");
        hasSubFolders = CkJsonObject_stringOf(jResp,"folders[i].hasSubFolders");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkJsonObject_Dispose(jsonToken);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }