DataFlex

SharePoint -- Delete a Folder

Demonstrates how to delete a SharePoint folder. DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoHttp
    Variant vReq
    Handle hoReq
    Boolean iBUseTls
    Variant vResp
    Handle hoResp
    Handle hoXml
    String sTemp1
    Integer iTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // If SharePoint Windows classic authentication is used, then set the 
    // Login, Password, LoginDomain, and NtlmAuth properties.
    Set ComLogin Of hoHttp To "SHAREPOINT_USERNAME"
    Set ComPassword Of hoHttp To "SHAREPOINT_PASSWORD"
    Set ComLoginDomain Of hoHttp To "SHAREPOINT_NTLM_DOMAIN"
    Set ComNtlmAuth Of hoHttp To 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

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

    Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
    If (Not(IsComObjectCreated(hoReq))) Begin
        Send CreateComObject of hoReq
    End
    Set ComHttpVerb Of hoReq To "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.
    Set ComPath Of hoReq To "/_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
    Send ComAddHeader To hoReq "X-RequestDigest" "SHAREPOINT_FORM_DIGEST"

    // Add additional required headers.
    Send ComAddHeader To hoReq "IF-MATCH" "*"
    Send ComAddHeader To hoReq "X-HTTP-Method" "DELETE"

    // Send the POST using https (TLS). (Port 443 is the default port for https.)
    Move True To iBUseTls
    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoReq to vReq
    Get pvComObject of hoResp to vResp
    Get ComHttpSReq Of hoHttp "SHAREPOINT_HTTPS_DOMAIN" 443 iBUseTls vReq vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // If failed, the response body contains XML 
    Get Create (RefClass(cComChilkatXml)) To hoXml
    If (Not(IsComObjectCreated(hoXml))) Begin
        Send CreateComObject of hoXml
    End
    Get ComBodyStr Of hoResp To sTemp1
    Get ComLoadXml Of hoXml sTemp1 To iSuccess

    // 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.
    Get ComStatusCode Of hoResp To iTemp1
    If (iTemp1 <> 200) Begin
        Get ComStatusCode Of hoResp To iTemp1
        Showln "Response status code = " iTemp1
        Get ComGetXml Of hoXml To sTemp1
        Showln sTemp1
        Showln "Failed"
        Procedure_Return
    End

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


End_Procedure