(Unicode C) DocuSign List Envelope Documents

See more DocuSign Examples

Retrieve a list of all documents within a specific envelope.

For more information, see https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/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_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW jsonToken;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *documentId;
    const wchar_t *documentIdGuid;
    const wchar_t *name;
    const wchar_t *v_type;
    const wchar_t *uri;
    const wchar_t *order;
    const wchar_t *display;
    const wchar_t *includeInDownload;
    const wchar_t *signerMustAcknowledge;
    const wchar_t *templateRequired;
    const wchar_t *authoritativeCopy;
    int j;
    int count_j;
    const wchar_t *pageId;
    const wchar_t *sequence;
    const wchar_t *height;
    const wchar_t *width;
    const wchar_t *dpi;
    const wchar_t *isDefault;
    const wchar_t *envelopeId;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

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

    // Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
    jsonToken = CkJsonObjectW_Create();
    // Load a previously obtained OAuth2 access token.
    success = CkJsonObjectW_LoadFile(jsonToken,L"qa_data/tokens/docusign.json");
    if (success == FALSE) {
        wprintf(L"%s\n",CkJsonObjectW_lastErrorText(jsonToken));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(jsonToken);
        return;
    }

    CkHttpW_putAuthToken(http,CkJsonObjectW_stringOf(jsonToken,L"access_token"));

    // Use your account ID and a valid envelopeId here:
    CkHttpW_SetUrlVar(http,L"accountId",L"7f3f65ed-5e87-418d-94c1-92499ddc8252");
    CkHttpW_SetUrlVar(http,L"envelopeId",L"90d7e40a-b4bd-4ccd-bf38-c80e37954a13");

    sbResponseBody = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents",sbResponseBody);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(jsonToken);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpW_getLastStatus(http);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpW_lastHeader(http));
        wprintf(L"Failed.\n");
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(jsonToken);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

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

    // {
    //   "envelopeId": "90d7e40a-b4bd-4ccd-bf38-c80e37954a13",
    //   "envelopeDocuments": [
    //     {
    //       "documentId": "1",
    //       "documentIdGuid": "ca1d3cc6-9bc3-48d6-a5d8-a85d9acdcde1",
    //       "name": "helloWorld.pdf",
    //       "type": "content",
    //       "uri": "/envelopes/90d7e40a-b4bd-4ccd-bf38-c80e37954a13/documents/1",
    //       "order": "1",
    //       "pages": [
    //         {
    //           "pageId": "fbf93a36-6b60-484d-94bd-ee3c08c0a546",
    //           "sequence": "1",
    //           "height": "842",
    //           "width": "595",
    //           "dpi": "72"
    //         }
    //       ],
    //       "availableDocumentTypes": [
    //         {
    //           "type": "electronic",
    //           "isDefault": "true"
    //         }
    //       ],
    //       "display": "inline",
    //       "includeInDownload": "true",
    //       "signerMustAcknowledge": "no_interaction",
    //       "templateRequired": "false",
    //       "authoritativeCopy": "false"
    //     },
    //     {
    //       "documentId": "certificate",
    //       "documentIdGuid": "7479a5de-8d91-44a2-bc33-b76a9ba0f6e2",
    //       "name": "Summary",
    //       "type": "summary",
    //       "uri": "/envelopes/90d7e40a-b4bd-4ccd-bf38-c80e37954a13/documents/certificate",
    //       "order": "999",
    //       "availableDocumentTypes": [
    //         {
    //           "type": "electronic",
    //           "isDefault": "true"
    //         }
    //       ],
    //       "display": "inline",
    //       "includeInDownload": "true",
    //       "signerMustAcknowledge": "no_interaction",
    //       "templateRequired": "false",
    //       "authoritativeCopy": "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.

    envelopeId = CkJsonObjectW_stringOf(jResp,L"envelopeId");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"envelopeDocuments");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        documentId = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].documentId");
        documentIdGuid = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].documentIdGuid");
        name = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].name");
        v_type = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].type");
        uri = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].uri");
        order = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].order");
        display = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].display");
        includeInDownload = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].includeInDownload");
        signerMustAcknowledge = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].signerMustAcknowledge");
        templateRequired = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].templateRequired");
        authoritativeCopy = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].authoritativeCopy");
        j = 0;
        count_j = CkJsonObjectW_SizeOfArray(jResp,L"envelopeDocuments[i].pages");
        while (j < count_j) {
            CkJsonObjectW_putJ(jResp,j);
            pageId = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].pages[j].pageId");
            sequence = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].pages[j].sequence");
            height = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].pages[j].height");
            width = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].pages[j].width");
            dpi = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].pages[j].dpi");
            j = j + 1;
        }

        j = 0;
        count_j = CkJsonObjectW_SizeOfArray(jResp,L"envelopeDocuments[i].availableDocumentTypes");
        while (j < count_j) {
            CkJsonObjectW_putJ(jResp,j);
            v_type = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].availableDocumentTypes[j].type");
            isDefault = CkJsonObjectW_stringOf(jResp,L"envelopeDocuments[i].availableDocumentTypes[j].isDefault");
            j = j + 1;
        }

        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(jsonToken);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }