Delphi DLL

Retrieve a Particular SharePoint List as XML

See more SharePoint Examples

Downloads a particular SharePoint list and parses the XML. Delphi DLL

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

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
sbXml: HCkStringBuilder;
xml: HCkXml;
sbBase: HCkStringBuilder;
numEntries: Integer;
sbUri: HCkStringBuilder;
i: Integer;
title: PWideChar;

begin
success := False;

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

// -------------------------------------------------------------------------
// The following comments apply to SharePoint Windows classic authentication.
// -------------------------------------------------------------------------
// For example, imagine our SharePoint endpoint is https://xyzoffice.mycompany.com/
// The SHAREPOINT_NTLM_DOMAIN would be "mycompany.com"
// The SHAREPOINT_HTTPS_DOMAIN would be "xyzoffice.mycompany.com"
// Also, the SHAREPOINT_USERNAME would be just the name, not a full email address.
// for example, "chilkat" instead of "chilkat@mycompany.com"

http := CkHttp_Create();

// If SharePoint Windows classic authentication is used, then set the 
// Login, Password, LoginDomain, and NtlmAuth properties.
CkHttp_putLogin(http,'SHAREPOINT_USERNAME');
CkHttp_putPassword(http,'SHAREPOINT_PASSWORD');
CkHttp_putLoginDomain(http,'SHAREPOINT_NTLM_DOMAIN');
CkHttp_putNtlmAuth(http,True);

// -------------------------------------------------------------------------
// The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
// If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
// establish the cookie as shown at SharePoint Online Authentication
// -------------------------------------------------------------------------

// Indicate that we want an XML reply
CkHttp_putAccept(http,'application/atom+xml');
CkHttp_putAcceptCharset(http,'utf-8');

// The contents of a SharePoint list can be downloaded by it's URI,
// which has the following URL format:
// https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/items
// 
// To get the URI's for all SharePoint lists, 
// See Get SharePoint Lists.

// Download the list like this (where the SHAREPOINT_DOCUMENTS_GUID is replaced with the actual GUID)
sbXml := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid''SHAREPOINT_DOCUMENTS_GUID'')/items',sbXml);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

xml := CkXml_Create();
CkXml_LoadSb(xml,sbXml,True);

sbBase := CkStringBuilder_Create();
CkStringBuilder_Append(sbBase,CkXml__getAttrValue(xml,'xml:base'));
Memo1.Lines.Add('Base URL = ' + CkStringBuilder__getAsString(sbBase));

// Find the number of entries in this list.
numEntries := CkXml_NumChildrenHavingTag(xml,'entry');
Memo1.Lines.Add('Number of Entries in this SharePoint List = ' + IntToStr(numEntries));

sbUri := CkStringBuilder_Create();

i := 0;
while i < numEntries do
  begin
    CkXml_putI(xml,i);

    title := CkXml__getChildContent(xml,'entry[i]|content|m:properties|d:Title');

    CkStringBuilder_SetString(sbUri,CkStringBuilder__getAsString(sbBase));
    CkStringBuilder_Append(sbUri,CkXml__getChildContent(xml,'entry[i]|id'));

    Memo1.Lines.Add(IntToStr(i + 1) + ': ' + title);
    Memo1.Lines.Add('URI: ' + CkStringBuilder__getAsString(sbUri));

    i := i + 1;
  end;

// The output of this program (when I ran w/ my test SharePoint data) looks something like this:

// I found that not every item has a Title,  but as viewed in a browser, I can see each of the item's name.
// (The number of items agrees with what I can interactively see in a browser.) The mystery of what
// is being shown for the name (or title) in the browser will be investigated further as Chilkat
// continues to explore the SharePoint API...

// 	Base URL = https://xyzoffice.mycompany.com/_api/
// 	Number of Entries in this SharePoint List = 13
// 	1: Domain Name created for Exchange Docx
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(3)
// 	2: 
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(4)
// 	3: VCAC_RA_Design.docx
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(5)
// 	4: 
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(9)
// 	5: 
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(10)
// 	6: Architecture Briefv1
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(16)
// 	7: PowerPoint Presentation
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(17)
// 	8: 
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(18)
// 	9: 
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(19)
// 	10: 
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(20)
// 	11: FRC Summit Brief
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(21)
// 	12: VCAC DISA Brief 8-13-16
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(22)
// 	13: TEST PROCEDURE
// 	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(23)
// 
// 

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbXml);
CkXml_Dispose(xml);
CkStringBuilder_Dispose(sbBase);
CkStringBuilder_Dispose(sbUri);

end;