(C++) DocuSign List Folder Items

See more DocuSign Examples

Retrieves a list of the envelopes in the specified folder.

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

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 <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>

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

    CkHttp http;
    bool success;

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

    // Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
    CkJsonObject jsonToken;
    // Load a previously obtained OAuth2 access token.
    success = jsonToken.LoadFile("qa_data/tokens/docusign.json");
    if (success == false) {
        std::cout << jsonToken.lastErrorText() << "\r\n";
        return;
    }

    http.put_AuthToken(jsonToken.stringOf("access_token"));

    // Use your account ID and a valid folderId here:
    http.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252");
    http.SetUrlVar("folderId","94644782-31b7-4f82-a2c1-26d8a9306f8c");

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/folders/{$folderId}",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "resultSetSize": "sample string 1",
    //   "startPosition": "sample string 2",
    //   "endPosition": "sample string 3",
    //   "totalSetSize": "sample string 4",
    //   "previousUri": "sample string 5",
    //   "nextUri": "sample string 6",
    //   "folderItems": [
    //     {
    //       "ownerName": "sample string 1",
    //       "envelopeId": "sample string 2",
    //       "envelopeUri": "sample string 3",
    //       "status": "sample string 4",
    //       "senderName": "sample string 5",
    //       "senderEmail": "sample string 6",
    //       "createdDateTime": "sample string 7",
    //       "sentDateTime": "sample string 8",
    //       "completedDateTime": "sample string 9",
    //       "subject": "sample string 10",
    //       "templateId": "sample string 11",
    //       "name": "sample string 12",
    //       "shared": "sample string 13",
    //       "password": "sample string 14",
    //       "description": "sample string 15",
    //       "lastModified": "sample string 16",
    //       "pageCount": 17,
    //       "uri": "sample string 18",
    //       "is21CFRPart11": "sample string 19",
    //       "isSignatureProviderEnvelope": "sample string 20",
    //       "customFields": [
    //         {
    //           "fieldId": "sample string 1",
    //           "name": "sample string 2",
    //           "show": "sample string 3",
    //           "required": "sample string 4",
    //           "value": "sample string 5",
    //           "configurationType": "sample string 6",
    //           "errorDetails": {
    //             "errorCode": "sample string 1",
    //             "message": "sample string 2"
    //           }
    //         }
    //       ]
    //     }
    //   ]
    // }

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

    const char *ownerName = 0;
    const char *envelopeId = 0;
    const char *envelopeUri = 0;
    const char *status = 0;
    const char *senderName = 0;
    const char *senderEmail = 0;
    const char *createdDateTime = 0;
    const char *sentDateTime = 0;
    const char *completedDateTime = 0;
    const char *subject = 0;
    const char *templateId = 0;
    const char *name = 0;
    const char *shared = 0;
    const char *password = 0;
    const char *description = 0;
    const char *lastModified = 0;
    int pageCount;
    const char *uri = 0;
    const char *is21CFRPart11 = 0;
    const char *isSignatureProviderEnvelope = 0;
    int j;
    int count_j;
    const char *fieldId = 0;
    const char *show = 0;
    const char *required = 0;
    const char *value = 0;
    const char *configurationType = 0;
    const char *errorDetailsErrorCode = 0;
    const char *errorDetailsMessage = 0;

    const char *resultSetSize = jResp.stringOf("resultSetSize");
    const char *startPosition = jResp.stringOf("startPosition");
    const char *endPosition = jResp.stringOf("endPosition");
    const char *totalSetSize = jResp.stringOf("totalSetSize");
    const char *previousUri = jResp.stringOf("previousUri");
    const char *nextUri = jResp.stringOf("nextUri");
    int i = 0;
    int count_i = jResp.SizeOfArray("folderItems");
    while (i < count_i) {
        jResp.put_I(i);
        ownerName = jResp.stringOf("folderItems[i].ownerName");
        envelopeId = jResp.stringOf("folderItems[i].envelopeId");
        envelopeUri = jResp.stringOf("folderItems[i].envelopeUri");
        status = jResp.stringOf("folderItems[i].status");
        senderName = jResp.stringOf("folderItems[i].senderName");
        senderEmail = jResp.stringOf("folderItems[i].senderEmail");
        createdDateTime = jResp.stringOf("folderItems[i].createdDateTime");
        sentDateTime = jResp.stringOf("folderItems[i].sentDateTime");
        completedDateTime = jResp.stringOf("folderItems[i].completedDateTime");
        subject = jResp.stringOf("folderItems[i].subject");
        templateId = jResp.stringOf("folderItems[i].templateId");
        name = jResp.stringOf("folderItems[i].name");
        shared = jResp.stringOf("folderItems[i].shared");
        password = jResp.stringOf("folderItems[i].password");
        description = jResp.stringOf("folderItems[i].description");
        lastModified = jResp.stringOf("folderItems[i].lastModified");
        pageCount = jResp.IntOf("folderItems[i].pageCount");
        uri = jResp.stringOf("folderItems[i].uri");
        is21CFRPart11 = jResp.stringOf("folderItems[i].is21CFRPart11");
        isSignatureProviderEnvelope = jResp.stringOf("folderItems[i].isSignatureProviderEnvelope");
        j = 0;
        count_j = jResp.SizeOfArray("folderItems[i].customFields");
        while (j < count_j) {
            jResp.put_J(j);
            fieldId = jResp.stringOf("folderItems[i].customFields[j].fieldId");
            name = jResp.stringOf("folderItems[i].customFields[j].name");
            show = jResp.stringOf("folderItems[i].customFields[j].show");
            required = jResp.stringOf("folderItems[i].customFields[j].required");
            value = jResp.stringOf("folderItems[i].customFields[j].value");
            configurationType = jResp.stringOf("folderItems[i].customFields[j].configurationType");
            errorDetailsErrorCode = jResp.stringOf("folderItems[i].customFields[j].errorDetails.errorCode");
            errorDetailsMessage = jResp.stringOf("folderItems[i].customFields[j].errorDetails.message");
            j = j + 1;
        }

        i = i + 1;
    }
    }