PureBasic
PureBasic
Retrieve a Particular SharePoint List as XML
See more SharePoint Examples
Downloads a particular SharePoint list and parses the XML.Chilkat PureBasic Downloads
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkXml.pb"
Procedure ChilkatExample()
success.i = 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"
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; If SharePoint Windows classic authentication is used, then set the
; Login, Password, LoginDomain, and NtlmAuth properties.
CkHttp::setCkLogin(http, "SHAREPOINT_USERNAME")
CkHttp::setCkPassword(http, "SHAREPOINT_PASSWORD")
CkHttp::setCkLoginDomain(http, "SHAREPOINT_NTLM_DOMAIN")
CkHttp::setCkNtlmAuth(http, 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
CkHttp::setCkAccept(http, "application/atom+xml")
CkHttp::setCkAcceptCharset(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.i = CkStringBuilder::ckCreate()
If sbXml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid'SHAREPOINT_DOCUMENTS_GUID')/items",sbXml)
If success <> 1
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbXml)
ProcedureReturn
EndIf
xml.i = CkXml::ckCreate()
If xml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkXml::ckLoadSb(xml,sbXml,1)
sbBase.i = CkStringBuilder::ckCreate()
If sbBase.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckAppend(sbBase,CkXml::ckGetAttrValue(xml,"xml:base"))
Debug "Base URL = " + CkStringBuilder::ckGetAsString(sbBase)
; Find the number of entries in this list.
numEntries.i = CkXml::ckNumChildrenHavingTag(xml,"entry")
Debug "Number of Entries in this SharePoint List = " + Str(numEntries)
sbUri.i = CkStringBuilder::ckCreate()
If sbUri.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
i.i = 0
While i < numEntries
CkXml::setCkI(xml, i)
title.s = CkXml::ckGetChildContent(xml,"entry[i]|content|m:properties|d:Title")
CkStringBuilder::ckSetString(sbUri,CkStringBuilder::ckGetAsString(sbBase))
CkStringBuilder::ckAppend(sbUri,CkXml::ckGetChildContent(xml,"entry[i]|id"))
Debug Str(i + 1) + ": " + title
Debug "URI: " + CkStringBuilder::ckGetAsString(sbUri)
i = i + 1
Wend
; 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::ckDispose(http)
CkStringBuilder::ckDispose(sbXml)
CkXml::ckDispose(xml)
CkStringBuilder::ckDispose(sbBase)
CkStringBuilder::ckDispose(sbUri)
ProcedureReturn
EndProcedure