Ruby

Populi Get Roles

See more Populi Examples

Demonstrates the Populi getRoles task. Ruby

require 'chilkat'

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 = Chilkat::CkXml.new()
success = xml.LoadXmlFile("qa_data/tokens/populi_token.xml")
accessKey = xml.getChildContent("access_key")
if (xml.get_LastMethodSuccess() != true)
    print "Did not find the access_key" + "\n";
    exit
end

rest = Chilkat::CkRest.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.
bAutoReconnect = true
success = rest.Connect("yourcollege.populi.co",443,true,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

rest.put_Authorization(accessKey)

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

responseBody = rest.fullRequestFormUrlEncoded("POST","/api/index.php")
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

# We should expect a 200 response if successful.
if (rest.get_ResponseStatusCode() != 200)
    print "Request Header: " + "\n";
    print rest.lastRequestHeader() + "\n";
    print "----" + "\n";
    print "Response StatusCode = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "Response StatusLine: " + rest.responseStatusText() + "\n";
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print responseBody + "\n";
    exit
end

xml.LoadXml(responseBody)
print xml.getXml() + "\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>

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
end