Pascal (Lazarus/Delphi)

DocuSign List Envelope Documents

See more DocuSign Examples

Retrieve a list of all documents within a specific envelope. Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.Http,
  Chilkat.StringBuilder,
  Chilkat.JsonObject;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  http: THttp;
  jsonToken: TJsonObject;
  sbResponseBody: TStringBuilder;
  jResp: TJsonObject;
  respStatusCode: Integer;
  documentId: string;
  documentIdGuid: string;
  name: string;
  v_type: string;
  uri: string;
  order: string;
  display: string;
  includeInDownload: string;
  signerMustAcknowledge: string;
  templateRequired: string;
  authoritativeCopy: string;
  j: Integer;
  count_j: Integer;
  pageId: string;
  sequence: string;
  height: string;
  width: string;
  dpi: string;
  isDefault: string;
  envelopeId: string;
  i: Integer;
  count_i: Integer;

begin
  success := False;

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

  http := THttp.Create;

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

  //  Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
  jsonToken := TJsonObject.Create;
  //  Load a previously obtained OAuth2 access token.
  success := jsonToken.LoadFile('qa_data/tokens/docusign.json');
  if (success = False) then
    begin
      WriteLn(jsonToken.LastErrorText);
      Exit;
    end;

  http.AuthToken := jsonToken.StringOf('access_token');

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

  sbResponseBody := TStringBuilder.Create;
  success := http.QuickGetSb('https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents',sbResponseBody);
  if (success = False) then
    begin
      WriteLn(http.LastErrorText);
      Exit;
    end;

  jResp := TJsonObject.Create;
  jResp.LoadSb(sbResponseBody);
  jResp.EmitCompact := False;

  WriteLn('Response Body:');
  WriteLn(jResp.Emit());

  respStatusCode := http.LastStatus;
  WriteLn('Response Status Code = ' + respStatusCode);
  if (respStatusCode >= 400) then
    begin
      WriteLn('Response Header:');
      WriteLn(http.LastHeader);
      WriteLn('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 := jResp.StringOf('envelopeId');
  i := 0;
  count_i := jResp.SizeOfArray('envelopeDocuments');
  while i < count_i do
    begin
      jResp.I := i;
      documentId := jResp.StringOf('envelopeDocuments[i].documentId');
      documentIdGuid := jResp.StringOf('envelopeDocuments[i].documentIdGuid');
      name := jResp.StringOf('envelopeDocuments[i].name');
      v_type := jResp.StringOf('envelopeDocuments[i].type');
      uri := jResp.StringOf('envelopeDocuments[i].uri');
      order := jResp.StringOf('envelopeDocuments[i].order');
      display := jResp.StringOf('envelopeDocuments[i].display');
      includeInDownload := jResp.StringOf('envelopeDocuments[i].includeInDownload');
      signerMustAcknowledge := jResp.StringOf('envelopeDocuments[i].signerMustAcknowledge');
      templateRequired := jResp.StringOf('envelopeDocuments[i].templateRequired');
      authoritativeCopy := jResp.StringOf('envelopeDocuments[i].authoritativeCopy');
      j := 0;
      count_j := jResp.SizeOfArray('envelopeDocuments[i].pages');
      while j < count_j do
        begin
          jResp.J := j;
          pageId := jResp.StringOf('envelopeDocuments[i].pages[j].pageId');
          sequence := jResp.StringOf('envelopeDocuments[i].pages[j].sequence');
          height := jResp.StringOf('envelopeDocuments[i].pages[j].height');
          width := jResp.StringOf('envelopeDocuments[i].pages[j].width');
          dpi := jResp.StringOf('envelopeDocuments[i].pages[j].dpi');
          j := j + 1;
        end;

      j := 0;
      count_j := jResp.SizeOfArray('envelopeDocuments[i].availableDocumentTypes');
      while j < count_j do
        begin
          jResp.J := j;
          v_type := jResp.StringOf('envelopeDocuments[i].availableDocumentTypes[j].type');
          isDefault := jResp.StringOf('envelopeDocuments[i].availableDocumentTypes[j].isDefault');
          j := j + 1;
        end;

      i := i + 1;
    end;



  http.Free;
  jsonToken.Free;
  sbResponseBody.Free;
  jResp.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.