Unicode C

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". Unicode C

#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkHttpW http;
    HCkStringBuilderW sbJson;
    HCkJsonObjectW json;
    int itemCount;

    success = FALSE;

    //  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 = CkHttpW_Create();

    //  If SharePoint Windows classic authentication is used, then set the 
    //  Login, Password, LoginDomain, and NtlmAuth properties.
    CkHttpW_putLogin(http,L"SHAREPOINT_USERNAME");
    CkHttpW_putPassword(http,L"SHAREPOINT_PASSWORD");
    CkHttpW_putLoginDomain(http,L"SHAREPOINT_NTLM_DOMAIN");
    CkHttpW_putNtlmAuth(http,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
    //  -------------------------------------------------------------------------

    //  Indicate that we want a JSON reply
    CkHttpW_putAccept(http,L"application/json;odata=verbose");
    CkHttpW_putAcceptCharset(http,L"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.
    sbJson = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Briefing 02032017')",sbJson);
    if (success != TRUE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbJson);
        return;
    }

    json = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(json,sbJson);
    CkJsonObjectW_putEmitCompact(json,FALSE);

    //  To get the number of items in the folder:
    itemCount = CkJsonObjectW_IntOf(json,L"d.ItemCount");
    wprintf(L"Number of items: %d\n",itemCount);

    //  The full JSON response looks like the following:
    wprintf(L"%s\n",CkJsonObjectW_emit(json));

    //  { 
    //    "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": ""
    //    }
    //  }
    //  


    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbJson);
    CkJsonObjectW_Dispose(json);

    }