(Node.js) Populi Get Roles

Demonstrates the Populi getRoles task.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // 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.
    var xml = new chilkat.Xml();
    var success = xml.LoadXmlFile("qa_data/tokens/populi_token.xml");
    var accessKey = xml.GetChildContent("access_key");
    if (xml.LastMethodSuccess !== true) {
        console.log("Did not find the access_key");
        return;
    }

    var rest = new chilkat.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.
    var bAutoReconnect = true;
    success = rest.Connect("yourcollege.populi.co",443,true,bAutoReconnect);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    rest.Authorization = accessKey;

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

    var responseBody = rest.FullRequestFormUrlEncoded("POST","/api/index.php");
    if (rest.LastMethodSuccess !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    // We should expect a 200 response if successful.
    if (rest.ResponseStatusCode !== 200) {
        console.log("Request Header: ");
        console.log(rest.LastRequestHeader);
        console.log("----");
        console.log("Response StatusCode = " + rest.ResponseStatusCode);
        console.log("Response StatusLine: " + rest.ResponseStatusText);
        console.log("Response Header:");
        console.log(rest.ResponseHeader);
        console.log("Response Body:");
        console.log(responseBody);
        return;
    }

    xml.LoadXml(responseBody);
    console.log(xml.GetXml());

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

    var i;
    var count_i;
    var id;
    var name;
    var inactive;

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


}

chilkatExample();