(CkPython) Retrieve a Particular SharePoint List as XML

See more SharePoint Examples

Downloads a particular SharePoint list and parses the XML.

Chilkat Python Downloads install with pip pip3 install chilkat or download... Python Module for Windows, MacOS, Linux, Alpine Linux, Solaris

import sys
import chilkat

# 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 = chilkat.CkHttp()

# If SharePoint Windows classic authentication is used, then set the 
# Login, Password, LoginDomain, and NtlmAuth properties.
http.put_Login("SHAREPOINT_USERNAME")
http.put_Password("SHAREPOINT_PASSWORD")
http.put_LoginDomain("SHAREPOINT_NTLM_DOMAIN")
http.put_NtlmAuth(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
http.put_Accept("application/atom+xml")
http.put_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)
sbXml = chilkat.CkStringBuilder()
success = http.QuickGetSb("https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid'SHAREPOINT_DOCUMENTS_GUID')/items",sbXml)
if (success != True):
    print(http.lastErrorText())
    sys.exit()

xml = chilkat.CkXml()
xml.LoadSb(sbXml,True)

sbBase = chilkat.CkStringBuilder()
sbBase.Append(xml.getAttrValue("xml:base"))
print("Base URL = " + sbBase.getAsString())

# Find the number of entries in this list.
numEntries = xml.NumChildrenHavingTag("entry")
print("Number of Entries in this SharePoint List = " + str(numEntries))

sbUri = chilkat.CkStringBuilder()

i = 0
while i < numEntries :
    xml.put_I(i)

    title = xml.getChildContent("entry[i]|content|m:properties|d:Title")

    sbUri.SetString(sbBase.getAsString())
    sbUri.Append(xml.getChildContent("entry[i]|id"))

    print(str(i + 1) + ": " + title)
    print("URI: " + sbUri.getAsString())

    i = i + 1

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