C

Populi Get Roles

See more Populi Examples

Demonstrates the Populi getRoles task. C

#include <C_CkXml.h>
#include <C_CkRest.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkXml xml;
    const char *accessKey;
    HCkRest rest;
    BOOL bAutoReconnect;
    const char *responseBody;
    int i;
    int count_i;
    int id;
    const char *name;
    int inactive;

    success = FALSE;

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

    // First load the previously obtained API token.
    // See Get Populi Access Token for sample code showing how to get the API token.
    xml = CkXml_Create();
    success = CkXml_LoadXmlFile(xml,"qa_data/tokens/populi_token.xml");
    accessKey = CkXml_getChildContent(xml,"access_key");
    if (CkXml_getLastMethodSuccess(xml) != TRUE) {
        printf("Did not find the access_key\n");
        CkXml_Dispose(xml);
        return;
    }

    rest = CkRest_Create();

    // Connect using TLS.
    // A single REST object, once connected, can be used for many Populi REST API calls.
    // The auto-reconnect indicates that if the already-established HTTPS connection is closed,
    // then it will be automatically re-established as needed.
    bAutoReconnect = TRUE;
    success = CkRest_Connect(rest,"yourcollege.populi.co",443,TRUE,bAutoReconnect);
    if (success != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkXml_Dispose(xml);
        CkRest_Dispose(rest);
        return;
    }

    CkRest_putAuthorization(rest,accessKey);

    CkRest_AddQueryParam(rest,"task","getRoles");

    responseBody = CkRest_fullRequestFormUrlEncoded(rest,"POST","/api/index.php");
    if (CkRest_getLastMethodSuccess(rest) != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkXml_Dispose(xml);
        CkRest_Dispose(rest);
        return;
    }

    // We should expect a 200 response if successful.
    if (CkRest_getResponseStatusCode(rest) != 200) {
        printf("Request Header: \n");
        printf("%s\n",CkRest_lastRequestHeader(rest));
        printf("----\n");
        printf("Response StatusCode = %d\n",CkRest_getResponseStatusCode(rest));
        printf("Response StatusLine: %s\n",CkRest_responseStatusText(rest));
        printf("Response Header:\n");
        printf("%s\n",CkRest_responseHeader(rest));
        printf("Response Body:\n");
        printf("%s\n",responseBody);
        CkXml_Dispose(xml);
        CkRest_Dispose(rest);
        return;
    }

    CkXml_LoadXml(xml,responseBody);
    printf("%s\n",CkXml_getXml(xml));

    // Sample response:
    // Use this online tool to generate parsing code from sample XML: 
    // Generate Parsing Code from XML

    // <?xml version="1.0" encoding="ISO-8859-1"?>
    // <response>
    //     <role>
    //         <id>7</id>
    //         <name>Academic Admin</name>
    //         <inactive>0</inactive>
    //     </role>
    //     <role>
    //         <id>19</id>
    //         <name>Financial Aid</name>
    //         <inactive>0</inactive>
    //     </role>
    //     <role>
    //         <id>15</id>
    //         <name>Registrar</name>
    //         <inactive>0</inactive>
    //     </role>
    //     <role>
    //         <id>4</id>
    //         <name>Staff</name>
    //         <inactive>0</inactive>
    //     </role>
    //     <role>
    //         <id>1</id>
    //         <name>Everyone</name>
    //         <inactive>0</inactive>
    //     </role>
    // </response>

    i = 0;
    count_i = CkXml_NumChildrenHavingTag(xml,"role");
    while (i < count_i) {
        CkXml_putI(xml,i);
        id = CkXml_GetChildIntValue(xml,"role[i]|id");
        name = CkXml_getChildContent(xml,"role[i]|name");
        inactive = CkXml_GetChildIntValue(xml,"role[i]|inactive");
        i = i + 1;
    }



    CkXml_Dispose(xml);
    CkRest_Dispose(rest);

    }