(Unicode C) Retrieve a Particular SharePoint List as XML

See more SharePoint Examples

Downloads a particular SharePoint list and parses the XML.

Chilkat C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

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

void ChilkatSample(void)
    {
    HCkHttpW http;
    HCkStringBuilderW sbXml;
    BOOL success;
    HCkXmlW xml;
    HCkStringBuilderW sbBase;
    int numEntries;
    HCkStringBuilderW sbUri;
    int i;
    const wchar_t *title;

    // 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 an XML reply
    CkHttpW_putAccept(http,L"application/atom+xml");
    CkHttpW_putAcceptCharset(http,L"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)
    sbXml = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid'SHAREPOINT_DOCUMENTS_GUID')/items",sbXml);
    if (success != TRUE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbXml);
        return;
    }

    xml = CkXmlW_Create();
    CkXmlW_LoadSb(xml,sbXml,TRUE);

    sbBase = CkStringBuilderW_Create();
    CkStringBuilderW_Append(sbBase,CkXmlW_getAttrValue(xml,L"xml:base"));
    wprintf(L"Base URL = %s\n",CkStringBuilderW_getAsString(sbBase));

    // Find the number of entries in this list.
    numEntries = CkXmlW_NumChildrenHavingTag(xml,L"entry");
    wprintf(L"Number of Entries in this SharePoint List = %d\n",numEntries);

    sbUri = CkStringBuilderW_Create();

    i = 0;
    while (i < numEntries) {
        CkXmlW_putI(xml,i);

        title = CkXmlW_getChildContent(xml,L"entry[i]|content|m:properties|d:Title");

        CkStringBuilderW_SetString(sbUri,CkStringBuilderW_getAsString(sbBase));
        CkStringBuilderW_Append(sbUri,CkXmlW_getChildContent(xml,L"entry[i]|id"));

        wprintf(L"%d: %s\n",i + 1,title);
        wprintf(L"URI: %s\n",CkStringBuilderW_getAsString(sbUri));

        i = i + 1;
    }

    // The output of this program (when I ran w/ my test SharePoint data) looks something like this:

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

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


    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbXml);
    CkXmlW_Dispose(xml);
    CkStringBuilderW_Dispose(sbBase);
    CkStringBuilderW_Dispose(sbUri);

    }