Visual FoxPro

Retrieve a Particular SharePoint List as XML

See more SharePoint Examples

Downloads a particular SharePoint list and parses the XML. Visual FoxPro

LOCAL lnSuccess
LOCAL loHttp
LOCAL loSbXml
LOCAL loXml
LOCAL loSbBase
LOCAL lnNumEntries
LOCAL loSbUri
LOCAL i
LOCAL lcTitle

lnSuccess = 0

*  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"

loHttp = CreateObject('Chilkat.Http')

*  If SharePoint Windows classic authentication is used, then set the 
*  Login, Password, LoginDomain, and NtlmAuth properties.
loHttp.Login = "SHAREPOINT_USERNAME"
loHttp.Password = "SHAREPOINT_PASSWORD"
loHttp.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
loHttp.NtlmAuth = 1

*  -------------------------------------------------------------------------
*  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
loHttp.Accept = "application/atom+xml"
loHttp.AcceptCharset = "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)
loSbXml = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid'SHAREPOINT_DOCUMENTS_GUID')/items",loSbXml)
IF (lnSuccess <> 1) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbXml
    CANCEL
ENDIF

loXml = CreateObject('Chilkat.Xml')
loXml.LoadSb(loSbXml,1)

loSbBase = CreateObject('Chilkat.StringBuilder')
loSbBase.Append(loXml.GetAttrValue("xml:base"))
? "Base URL = " + loSbBase.GetAsString()

*  Find the number of entries in this list.
lnNumEntries = loXml.NumChildrenHavingTag("entry")
? "Number of Entries in this SharePoint List = " + STR(lnNumEntries)

loSbUri = CreateObject('Chilkat.StringBuilder')

i = 0
DO WHILE i < lnNumEntries
    loXml.I = i

    lcTitle = loXml.GetChildContent("entry[i]|content|m:properties|d:Title")

    loSbUri.SetString(loSbBase.GetAsString())
    loSbUri.Append(loXml.GetChildContent("entry[i]|id"))

    ? STR(i + 1) + ": " + lcTitle
    ? "URI: " + loSbUri.GetAsString()

    i = i + 1
ENDDO

*  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)
*  
*

RELEASE loHttp
RELEASE loSbXml
RELEASE loXml
RELEASE loSbBase
RELEASE loSbUri