Lua

Populi Get Roles

See more Populi Examples

Demonstrates the Populi getRoles task. Lua

local chilkat = require("chilkat")

-- 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.
local xml = chilkat.Xml.new()
local success = xml:load_xml_file("qa_data/tokens/populi_token.xml")
local accessKey = xml:get_child_content("access_key")
if not xml.last_method_success then
    print("Did not find the access_key")
    return
end

local rest = chilkat.Rest.new()

-- 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.
local bAutoReconnect = true
success = rest:connect("yourcollege.populi.co", 443, true, bAutoReconnect)
if not success then
    print(rest.last_error_text)
    return
end

rest.authorization = accessKey

rest:add_query_param("task", "getRoles")

local responseBody = rest:full_request_form_url_encoded("POST", "/api/index.php")
if not rest.last_method_success then
    print(rest.last_error_text)
    return
end

-- We should expect a 200 response if successful.
if rest.response_status_code ~= 200 then
    print("Request Header: ")
    print(rest.last_request_header)
    print("----")
    print("Response StatusCode = " .. rest.response_status_code)
    print("Response StatusLine: " .. rest.response_status_text)
    print("Response Header:")
    print(rest.response_header)
    print("Response Body:")
    print(responseBody)
    return
end

xml:load_xml(responseBody)
print(xml:get_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>

local id = 0
local name = ""
local inactive = 0

local i = 0
local count_i = xml:num_children_having_tag("role")
while i < count_i do
    xml.i = i
    id = xml:get_child_int_value("role[i]|id")
    name = xml:get_child_content("role[i]|name")
    inactive = xml:get_child_int_value("role[i]|inactive")
    i = i + 1
end