(Visual FoxPro) Populi Get Roles

Demonstrates the Populi getRoles task.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loXml
LOCAL lnSuccess
LOCAL lcAccessKey
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL lcResponseBody
LOCAL i
LOCAL lnCount_i
LOCAL lnId
LOCAL lcName
LOCAL lnInactive

* 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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Xml')
loXml = CreateObject('Chilkat.Xml')
lnSuccess = loXml.LoadXmlFile("qa_data/tokens/populi_token.xml")
lcAccessKey = loXml.GetChildContent("access_key")
IF (loXml.LastMethodSuccess <> 1) THEN
    ? "Did not find the access_key"
    RELEASE loXml
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Rest')
loRest = CreateObject('Chilkat.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.
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("yourcollege.populi.co",443,1,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loXml
    RELEASE loRest
    CANCEL
ENDIF

loRest.Authorization = lcAccessKey

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

lcResponseBody = loRest.FullRequestFormUrlEncoded("POST","/api/index.php")
IF (loRest.LastMethodSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loXml
    RELEASE loRest
    CANCEL
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
    CANCEL
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