C

Retrieve a Particular SharePoint List as JSON

See more SharePoint Examples

Downloads a particular SharePoint list and parses the JSON. C

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkHttp http;
    HCkStringBuilder sbJson;
    HCkJsonObject json;
    int numItems;
    int i;
    const char *title;
    const char *uri;

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

    //  If SharePoint Windows classic authentication is used, then set the 
    //  Login, Password, LoginDomain, and NtlmAuth properties.
    CkHttp_putLogin(http,"SHAREPOINT_USERNAME");
    CkHttp_putPassword(http,"SHAREPOINT_PASSWORD");
    CkHttp_putLoginDomain(http,"SHAREPOINT_NTLM_DOMAIN");
    CkHttp_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
    CkHttp_putAccept(http,"application/json;odata=verbose");
    CkHttp_putAcceptCharset(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)
    sbJson = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid'SHAREPOINT_DOCUMENTS_GUID')/items",sbJson);
    if (success != TRUE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbJson);
        return;
    }

    json = CkJsonObject_Create();
    CkJsonObject_LoadSb(json,sbJson);
    CkJsonObject_putEmitCompact(json,FALSE);

    //  Iterate over the items in this list.
    numItems = CkJsonObject_SizeOfArray(json,"d.results");
    printf("Number of Items in this SharePoint List = %d\n",numItems);

    i = 0;
    while (i < numItems) {
        CkJsonObject_putI(json,i);

        title = CkJsonObject_stringOf(json,"d.results[i].Title");
        uri = CkJsonObject_stringOf(json,"d.results[i].__metadata.uri");

        printf("%d: %s\n",i + 1,title);
        //  This is the URI for the Nth item in this list
        printf("URI: %s\n",uri);

        i = i + 1;
    }

    //  My output when testing is like what is shown below.

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

    //  	Number of Items 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: null
    //  	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: null
    //  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(9)
    //  	5: null
    //  	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: null
    //  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(18)
    //  	9: null
    //  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(19)
    //  	10: null
    //  	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)
    //  


    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbJson);
    CkJsonObject_Dispose(json);

    }