Tcl

Populi Get Roles

See more Populi Examples

Demonstrates the Populi getRoles task. Tcl

load ./chilkat.dll

set success 0

# 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.
set xml [new_CkXml]

set success [CkXml_LoadXmlFile $xml "qa_data/tokens/populi_token.xml"]
set accessKey [CkXml_getChildContent $xml "access_key"]
if {[CkXml_get_LastMethodSuccess $xml] != 1} then {
    puts "Did not find the access_key"
    delete_CkXml $xml
    exit
}

set rest [new_CkRest]

# 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.
set bAutoReconnect 1
set success [CkRest_Connect $rest "yourcollege.populi.co" 443 1 $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkXml $xml
    delete_CkRest $rest
    exit
}

CkRest_put_Authorization $rest $accessKey

CkRest_AddQueryParam $rest "task" "getRoles"

set responseBody [CkRest_fullRequestFormUrlEncoded $rest "POST" "/api/index.php"]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkXml $xml
    delete_CkRest $rest
    exit
}

# We should expect a 200 response if successful.
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts "Request Header: "
    puts [CkRest_lastRequestHeader $rest]
    puts "----"
    puts "Response StatusCode = [CkRest_get_ResponseStatusCode $rest]"
    puts "Response StatusLine: [CkRest_responseStatusText $rest]"
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts "$responseBody"
    delete_CkXml $xml
    delete_CkRest $rest
    exit
}

CkXml_LoadXml $xml $responseBody
puts [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>

set i 0
set count_i [CkXml_NumChildrenHavingTag $xml "role"]
while {$i < $count_i} {
    CkXml_put_I $xml $i
    set id [CkXml_GetChildIntValue $xml "role[i]|id"]
    set name [CkXml_getChildContent $xml "role[i]|name"]
    set inactive [CkXml_GetChildIntValue $xml "role[i]|inactive"]
    set i [expr $i + 1]
}

delete_CkXml $xml
delete_CkRest $rest