Visual FoxPro

SharePoint -- Get Folder Properties

See more SharePoint Examples

This example shows how to get the properties of a SharePoint folder. Specifically, it gets the properties of one of our test folders named "Briefing 02032017". Visual FoxPro

LOCAL lnSuccess
LOCAL loHttp
LOCAL loSbJson
LOCAL loJson
LOCAL lnItemCount

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 a JSON reply
loHttp.Accept = "application/json;odata=verbose"
loHttp.AcceptCharset = "utf-8"

* If your Sharepoint site is within a site collection, then use "https://SHAREPOINT_HTTPS_DOMAIN/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/Briefing 02032017')" where "teamA" is the name of the site.
loSbJson = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Briefing 02032017')",loSbJson)
IF (lnSuccess <> 1) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbJson
    CANCEL
ENDIF

loJson = CreateObject('Chilkat.JsonObject')
loJson.LoadSb(loSbJson)
loJson.EmitCompact = 0

* To get the number of items in the folder:
lnItemCount = loJson.IntOf("d.ItemCount")
? "Number of items: " + STR(lnItemCount)

* The full JSON response looks like the following:
? loJson.Emit()

* { 
*   "d": { 
*     "__metadata": { 
*       "id": "Web/GetFolderByServerRelativeUrl('/Briefing 02032017')",
*       "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')",
*       "type": "SP.Folder"
*     },
*     "Files": { 
*       "__deferred": { 
*         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/Files"
*       }
*     },
*     "ListItemAllFields": { 
*       "__deferred": { 
*         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/ListItemAllFields"
*       }
*     },
*     "ParentFolder": { 
*       "__deferred": { 
*         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/ParentFolder"
*       }
*     },
*     "Properties": { 
*       "__deferred": { 
*         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/Properties"
*       }
*     },
*     "Folders": { 
*       "__deferred": { 
*         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/Folders"
*       }
*     },
*     "ItemCount": 9,
*     "Name": "Briefing 02032017",
*     "ServerRelativeUrl": "/Briefing 02032017",
*     "WelcomePage": ""
*   }
* }
* 

RELEASE loHttp
RELEASE loSbJson
RELEASE loJson