(Xojo Plugin) Populi Search People

Demonstrates the Populi searchPeople task.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

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

rest.Authorization = accessKey

success = rest.AddQueryParam("task","searchPeople")
success = rest.AddQueryParam("search_term","Robert")
success = rest.AddQueryParam("limit","10")

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

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

success = xml.LoadXml(responseBody)
System.DebugLog(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="UTF-8"?>
//  <response>
// 	<person>
// 		<id>11111</id>
// 		<first_name>Robert</first_name>
// 		<last_name>McStudent</last_name>
// 		<middle_name>Kensington</middle_name>
// 		<preferred_name>Bobby</preferred_name>
// 		<is_user>1</is_user>
// 		<primary_email>r.mcstudent@myschool.edu</primary_email>
// 	</person>
// 	<person>
// 		<id>2222</id>
// 		<first_name>Robert</first_name>
// 		<last_name>McBoardmember</last_name>
// 		<middle_name/>
// 		<preferred_name/>
// 		<is_user>0</is_user>
// 		<primary_email>robert@gmail.com</primary_email>
// 	</person>
// </response>

Dim i As Int32
Dim count_i As Int32
Dim id As Int32
Dim first_name As String
Dim last_name As String
Dim middle_name As String
Dim preferred_name As String
Dim is_user As Int32
Dim primary_email As String

i = 0
count_i = xml.NumChildrenHavingTag("person")
While i < count_i
    xml.I = i
    id = xml.GetChildIntValue("person[i]|id")
    first_name = xml.GetChildContent("person[i]|first_name")
    last_name = xml.GetChildContent("person[i]|last_name")
    middle_name = xml.GetChildContent("person[i]|middle_name")
    preferred_name = xml.GetChildContent("person[i]|preferred_name")
    is_user = xml.GetChildIntValue("person[i]|is_user")
    primary_email = xml.GetChildContent("person[i]|primary_email")
    i = i + 1
Wend