Pascal (Lazarus/Delphi)

DocuSign List Folders

See more DocuSign Examples

Retrieves a list of the folders for the account, including the folder hierarchy. You can specify type kinds of folders to return with the include query parameter. 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;
  name: string;
  v_type: string;
  ownerUserName: string;
  ownerUserId: string;
  ownerEmail: string;
  folderId: string;
  uri: string;
  itemCount: string;
  subFolderCount: string;
  hasSubFolders: string;
  resultSetSize: string;
  startPosition: string;
  endPosition: string;
  totalSetSize: 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}/folders

  //  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 here:
  http.SetUrlVar('accountId','7f3f65ed-5e87-418d-94c1-92499ddc8252');

  sbResponseBody := TStringBuilder.Create;
  success := http.QuickGetSb('https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/folders',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)

  //  {
  //    "resultSetSize": "4",
  //    "startPosition": "0",
  //    "endPosition": "3",
  //    "totalSetSize": "4",
  //    "folders": [
  //      {
  //        "name": "Draft",
  //        "type": "draft",
  //        "owner": {
  //          "userName": "Joe Sample",
  //          "userId": "14602117-2430-4582-8a49-ba8766302272",
  //          "email": "admin@chilkatsoft.com"
  //        },
  //        "folderId": "f0bc5174-610d-4d80-80d7-91037843ccdb",
  //        "uri": "/folders/f0bc5174-610d-4d80-80d7-91037843ccdb",
  //        "itemCount": "0",
  //        "subFolderCount": "0",
  //        "hasSubFolders": "false"
  //      },
  //      {
  //        "name": "Inbox",
  //        "type": "inbox",
  //        "owner": {
  //          "userName": "Joe Sample",
  //          "userId": "14602117-2430-4582-8a49-ba8766302272",
  //          "email": "admin@chilkatsoft.com"
  //        },
  //        "folderId": "06c97346-f7b4-46fd-a204-038287d655ec",
  //        "uri": "/folders/06c97346-f7b4-46fd-a204-038287d655ec",
  //        "itemCount": "1",
  //        "subFolderCount": "0",
  //        "hasSubFolders": "false"
  //      },
  //      {
  //        "name": "Deleted Items",
  //        "type": "recyclebin",
  //        "owner": {
  //          "userName": "Joe Sample",
  //          "userId": "14602117-2430-4582-8a49-ba8766302272",
  //          "email": "admin@chilkatsoft.com"
  //        },
  //        "folderId": "6df0919e-b152-49fc-a4c9-9b430a29d4f5",
  //        "uri": "/folders/6df0919e-b152-49fc-a4c9-9b430a29d4f5",
  //        "itemCount": "0",
  //        "subFolderCount": "0",
  //        "hasSubFolders": "false"
  //      },
  //      {
  //        "name": "Sent Items",
  //        "type": "sentitems",
  //        "owner": {
  //          "userName": "Joe Sample",
  //          "userId": "14602117-2430-4582-8a49-ba8766302272",
  //          "email": "admin@chilkatsoft.com"
  //        },
  //        "folderId": "456f3c76-b265-4453-a024-c39b1a5cb387",
  //        "uri": "/folders/456f3c76-b265-4453-a024-c39b1a5cb387",
  //        "itemCount": "1",
  //        "subFolderCount": "0",
  //        "hasSubFolders": "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

  resultSetSize := jResp.StringOf('resultSetSize');
  startPosition := jResp.StringOf('startPosition');
  endPosition := jResp.StringOf('endPosition');
  totalSetSize := jResp.StringOf('totalSetSize');
  i := 0;
  count_i := jResp.SizeOfArray('folders');
  while i < count_i do
    begin
      jResp.I := i;
      name := jResp.StringOf('folders[i].name');
      v_type := jResp.StringOf('folders[i].type');
      ownerUserName := jResp.StringOf('folders[i].owner.userName');
      ownerUserId := jResp.StringOf('folders[i].owner.userId');
      ownerEmail := jResp.StringOf('folders[i].owner.email');
      folderId := jResp.StringOf('folders[i].folderId');
      uri := jResp.StringOf('folders[i].uri');
      itemCount := jResp.StringOf('folders[i].itemCount');
      subFolderCount := jResp.StringOf('folders[i].subFolderCount');
      hasSubFolders := jResp.StringOf('folders[i].hasSubFolders');
      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.