Lianja

Populi Get Roles

See more Populi Examples

Demonstrates the Populi getRoles task. Lianja

llSuccess = .F.

// 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.
loXml = createobject("CkXml")
llSuccess = loXml.LoadXmlFile("qa_data/tokens/populi_token.xml")
lcAccessKey = loXml.GetChildContent("access_key")
if (loXml.LastMethodSuccess <> .T.) then
    ? "Did not find the access_key"
    release loXml
    return
endif

loRest = createobject("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.
llBAutoReconnect = .T.
llSuccess = loRest.Connect("yourcollege.populi.co",443,.T.,llBAutoReconnect)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loXml
    release loRest
    return
endif

loRest.Authorization = lcAccessKey

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

lcResponseBody = loRest.FullRequestFormUrlEncoded("POST","/api/index.php")
if (loRest.LastMethodSuccess <> .T.) then
    ? loRest.LastErrorText
    release loXml
    release loRest
    return
endif

// We should expect a 200 response if successful.
if (loRest.ResponseStatusCode <> 200) then
    ? "Request Header: "
    ? loRest.LastRequestHeader
    ? "----"
    ? "Response StatusCode = " + str(loRest.ResponseStatusCode)
    ? "Response StatusLine: " + loRest.ResponseStatusText
    ? "Response Header:"
    ? loRest.ResponseHeader
    ? "Response Body:"
    ? lcResponseBody
    release loXml
    release loRest
    return
endif

loXml.LoadXml(lcResponseBody)
? loXml.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
lnCount_i = loXml.NumChildrenHavingTag("role")
do while i < lnCount_i
    loXml.I = i
    lnId = loXml.GetChildIntValue("role[i]|id")
    lcName = loXml.GetChildContent("role[i]|name")
    lnInactive = loXml.GetChildIntValue("role[i]|inactive")
    i = i + 1
enddo


release loXml
release loRest