Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

Tcl Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Tcl) Retrieve a Particular SharePoint List as XML

See more SharePoint Examples

Downloads a particular SharePoint list and parses the XML.

Chilkat Tcl Extension Downloads

Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# If SharePoint Windows classic authentication is used, then set the 
# Login, Password, LoginDomain, and NtlmAuth properties.
CkHttp_put_Login $http "SHAREPOINT_USERNAME"
CkHttp_put_Password $http "SHAREPOINT_PASSWORD"
CkHttp_put_LoginDomain $http "SHAREPOINT_NTLM_DOMAIN"
CkHttp_put_NtlmAuth $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_put_Accept $http "application/atom+xml"
CkHttp_put_AcceptCharset $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)
set sbXml [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid'SHAREPOINT_DOCUMENTS_GUID')/items" $sbXml]
if {$success != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbXml
    exit
}

set xml [new_CkXml]

CkXml_LoadSb $xml $sbXml 1

set sbBase [new_CkStringBuilder]

CkStringBuilder_Append $sbBase [CkXml_getAttrValue $xml "xml:base"]
puts "Base URL = [CkStringBuilder_getAsString $sbBase]"

# Find the number of entries in this list.
set numEntries [CkXml_NumChildrenHavingTag $xml "entry"]
puts "Number of Entries in this SharePoint List = $numEntries"

set sbUri [new_CkStringBuilder]

set i 0
while {$i < $numEntries} {
    CkXml_put_I $xml $i

    set 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"]

    puts [expr $i + 1]: $title
    puts "URI: [CkStringBuilder_getAsString $sbUri]"

    set i [expr $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)
# 
# 

delete_CkHttp $http
delete_CkStringBuilder $sbXml
delete_CkXml $xml
delete_CkStringBuilder $sbBase
delete_CkStringBuilder $sbUri

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.