(Delphi DLL) 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 for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, StringBuilder, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
http: HCkHttp;
success: Boolean;
jsonToken: HCkJsonObject;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
documentId: PWideChar;
documentIdGuid: PWideChar;
name: PWideChar;
v_type: PWideChar;
uri: PWideChar;
order: PWideChar;
display: PWideChar;
includeInDownload: PWideChar;
signerMustAcknowledge: PWideChar;
templateRequired: PWideChar;
authoritativeCopy: PWideChar;
j: Integer;
count_j: Integer;
pageId: PWideChar;
sequence: PWideChar;
height: PWideChar;
width: PWideChar;
dpi: PWideChar;
isDefault: PWideChar;
envelopeId: PWideChar;
i: Integer;
count_i: Integer;

begin
// 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) then
  begin
    Memo1.Lines.Add(CkJsonObject__lastErrorText(jsonToken));
    Exit;
  end;

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) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

envelopeId := CkJsonObject__stringOf(jResp,'envelopeId');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'envelopeDocuments');
while i < count_i do
  begin
    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 do
      begin
        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;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'envelopeDocuments[i].availableDocumentTypes');
    while j < count_j do
      begin
        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;
      end;

    i := i + 1;
  end;

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

end;