PowerShell

Populi Search People

See more Populi Examples

Demonstrates the Populi searchPeople task. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $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.
$xml = New-Object Chilkat.Xml
$success = $xml.LoadXmlFile("qa_data/tokens/populi_token.xml")
$accessKey = $xml.GetChildContent("access_key")
if ($xml.LastMethodSuccess -ne $true) {
    $("Did not find the access_key")
    exit
}

$rest = New-Object 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.
$bAutoReconnect = $true
$success = $rest.Connect("yourcollege.populi.co",443,$true,$bAutoReconnect)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$rest.Authorization = $accessKey

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

$responseBody = $rest.FullRequestFormUrlEncoded("POST","/api/index.php")
if ($rest.LastMethodSuccess -ne $true) {
    $($rest.LastErrorText)
    exit
}

# We should expect a 200 response if successful.
if ($rest.ResponseStatusCode -ne 200) {
    $("Request Header: ")
    $($rest.LastRequestHeader)
    $("----")
    $("Response StatusCode = " + $rest.ResponseStatusCode)
    $("Response StatusLine: " + $rest.ResponseStatusText)
    $("Response Header:")
    $($rest.ResponseHeader)
    $("Response Body:")
    $($responseBody)
    exit
}

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

$i = 0
$count_i = $xml.NumChildrenHavingTag("person")
while ($i -lt $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
}