Lianja

SharePoint -- Delete a Folder

Demonstrates how to delete a SharePoint folder. Lianja

llSuccess = .F.

// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

// 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 = .T.

// 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

// This example will delete the folder /Documents/ChilkatTest2

loReq = createobject("CkHttpRequest")
loReq.HttpVerb = "POST"
// If your Sharepoint site is within a site collection, then use "/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/Documents/ChilkatTest2')" where "teamA" is the name of the site.
loReq.Path = "/_api/web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest2')"

// We need to add a form digest value in the X-RequestDigest header field.
// See this example for details on
// how to get (and cache) a form digest value
loReq.AddHeader("X-RequestDigest","SHAREPOINT_FORM_DIGEST")

// Add additional required headers.
loReq.AddHeader("IF-MATCH","*")
loReq.AddHeader("X-HTTP-Method","DELETE")

// Send the POST using https (TLS). (Port 443 is the default port for https.)
llBUseTls = .T.
loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpSReq("SHAREPOINT_HTTPS_DOMAIN",443,llBUseTls,loReq,loResp)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loReq
    release loResp
    return
endif

// If failed, the response body contains XML 
loXml = createobject("CkXml")
loXml.LoadXml(loResp.BodyStr)

// Note: It seems that if an attempt is made to delete a folder that does not exist,
// the response status code is 200, indicating success.
if (loResp.StatusCode <> 200) then
    ? "Response status code = " + str(loResp.StatusCode)
    ? loXml.GetXml()
    ? "Failed"
    release loHttp
    release loReq
    release loResp
    release loXml
    return
endif

// If successful, the response body is empty.
? "Success."


release loHttp
release loReq
release loResp
release loXml