C++

Populi Get Roles

See more Populi Examples

Demonstrates the Populi getRoles task. C++

#include <CkXml.h>
#include <CkRest.h>

void ChilkatSample(void)
    {
    bool 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.
    CkXml xml;
    success = xml.LoadXmlFile("qa_data/tokens/populi_token.xml");
    const char *accessKey = xml.getChildContent("access_key");
    if (xml.get_LastMethodSuccess() != true) {
        std::cout << "Did not find the access_key" << "\r\n";
        return;
    }

    CkRest rest;

    //  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.
    bool bAutoReconnect = true;
    success = rest.Connect("yourcollege.populi.co",443,true,bAutoReconnect);
    if (success != true) {
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

    rest.put_Authorization(accessKey);

    rest.AddQueryParam("task","getRoles");

    const char *responseBody = rest.fullRequestFormUrlEncoded("POST","/api/index.php");
    if (rest.get_LastMethodSuccess() != true) {
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

    //  We should expect a 200 response if successful.
    if (rest.get_ResponseStatusCode() != 200) {
        std::cout << "Request Header: " << "\r\n";
        std::cout << rest.lastRequestHeader() << "\r\n";
        std::cout << "----" << "\r\n";
        std::cout << "Response StatusCode = " << rest.get_ResponseStatusCode() << "\r\n";
        std::cout << "Response StatusLine: " << rest.responseStatusText() << "\r\n";
        std::cout << "Response Header:" << "\r\n";
        std::cout << rest.responseHeader() << "\r\n";
        std::cout << "Response Body:" << "\r\n";
        std::cout << responseBody << "\r\n";
        return;
    }

    xml.LoadXml(responseBody);
    std::cout << xml.getXml() << "\r\n";

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

    int i;
    int count_i;
    int id;
    const char *name = 0;
    int inactive;

    i = 0;
    count_i = xml.NumChildrenHavingTag("role");
    while (i < count_i) {
        xml.put_I(i);
        id = xml.GetChildIntValue("role[i]|id");
        name = xml.getChildContent("role[i]|name");
        inactive = xml.GetChildIntValue("role[i]|inactive");
        i = i + 1;
    }
    }