B4X

Populi Get Roles

See more Populi Examples

Demonstrates the Populi getRoles task. B4X

Dim success As Boolean = 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.
Dim xml As ChilkatXml
xml.Initialize
success = xml.LoadXmlFile("qa_data/tokens/populi_token.xml")
Dim accessKey As String = xml.GetChildContent("access_key")
If xml.LastMethodSuccess <> True Then
    Log("Did not find the access_key")
    Return
End If


Dim rest As ChilkatRest
rest.Initialize("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.
Dim bAutoReconnect As Boolean = True
success = rest.Connect("yourcollege.populi.co", 443, True, bAutoReconnect)
If success <> True Then
    Log(rest.LastErrorText)
    Return
End If


rest.Authorization = accessKey

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

Dim responseBody As String = rest.FullRequestFormUrlEncoded("POST", "/api/index.php")
If rest.LastMethodSuccess <> True Then
    Log(rest.LastErrorText)
    Return
End If


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


xml.LoadXml(responseBody)
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>

Dim i As Int
Dim count_i As Int
Dim id As Int
Dim name As String
Dim inactive As Int

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