C

DocuSign List Envelope Documents

See more DocuSign Examples

Retrieve a list of all documents within a specific envelope. C

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

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

    success = FALSE;

    // 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}/envelopes/{envelopeId}/documents

    // 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 and a valid envelopeId here:
    CkHttp_SetUrlVar(http,"accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252");
    CkHttp_SetUrlVar(http,"envelopeId","90d7e40a-b4bd-4ccd-bf38-c80e37954a13");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents",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)

    // {
    //   "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 = CkJsonObject_stringOf(jResp,"envelopeId");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"envelopeDocuments");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        documentId = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].documentId");
        documentIdGuid = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].documentIdGuid");
        name = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].name");
        v_type = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].type");
        uri = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].uri");
        order = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].order");
        display = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].display");
        includeInDownload = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].includeInDownload");
        signerMustAcknowledge = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].signerMustAcknowledge");
        templateRequired = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].templateRequired");
        authoritativeCopy = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].authoritativeCopy");
        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"envelopeDocuments[i].pages");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            pageId = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].pages[j].pageId");
            sequence = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].pages[j].sequence");
            height = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].pages[j].height");
            width = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].pages[j].width");
            dpi = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].pages[j].dpi");
            j = j + 1;
        }

        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"envelopeDocuments[i].availableDocumentTypes");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            v_type = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].availableDocumentTypes[j].type");
            isDefault = CkJsonObject_stringOf(jResp,"envelopeDocuments[i].availableDocumentTypes[j].isDefault");
            j = j + 1;
        }

        i = i + 1;
    }



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

    }