(Excel) Populi Get Roles

Demonstrates the Populi getRoles task.

Download Excel Class Modules Chilkat Excel Class Modules

' 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.
Dim xml As Chilkat.Xml
Set xml = Chilkat.NewXml

success = xml.LoadXmlFile("qa_data/tokens/populi_token.xml")

accessKey = xml.GetChildContent("access_key")
If (xml.LastMethodSuccess <> True) Then
    Debug.Print "Did not find the access_key"
    Exit Sub
End If

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

' 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) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

rest.Authorization = accessKey

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


responseBody = rest.FullRequestFormUrlEncoded("POST","/api/index.php")
If (rest.LastMethodSuccess <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' We should expect a 200 response if successful.
If (rest.ResponseStatusCode <> 200) Then
    Debug.Print "Request Header: "
    Debug.Print rest.LastRequestHeader
    Debug.Print "----"
    Debug.Print "Response StatusCode = "; rest.ResponseStatusCode
    Debug.Print "Response StatusLine: "; rest.ResponseStatusText
    Debug.Print "Response Header:"
    Debug.Print rest.ResponseHeader
    Debug.Print "Response Body:"
    Debug.Print responseBody
    Exit Sub
End If

success = xml.LoadXml(responseBody)
Debug.Print 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>

i = 0
count_i = xml.NumChildrenHavingTag("role")
Do 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
Loop