(CkPython) Populi Search People

Demonstrates the Populi searchPeople task.

Chilkat Python Downloads install with pip pip3 install chilkat or download... Python Module for Windows, MacOS, Linux, Alpine Linux, Solaris

import sys
import chilkat

# 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 = chilkat.CkXml()
success = xml.LoadXmlFile("qa_data/tokens/populi_token.xml")
accessKey = xml.getChildContent("access_key")
if (xml.get_LastMethodSuccess() != True):
    print("Did not find the access_key")
    sys.exit()

rest = chilkat.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.
bAutoReconnect = True
success = rest.Connect("yourcollege.populi.co",443,True,bAutoReconnect)
if (success != True):
    print(rest.lastErrorText())
    sys.exit()

rest.put_Authorization(accessKey)

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

responseBody = rest.fullRequestFormUrlEncoded("POST","/api/index.php")
if (rest.get_LastMethodSuccess() != True):
    print(rest.lastErrorText())
    sys.exit()

# We should expect a 200 response if successful.
if (rest.get_ResponseStatusCode() != 200):
    print("Request Header: ")
    print(rest.lastRequestHeader())
    print("----")
    print("Response StatusCode = " + str(rest.get_ResponseStatusCode()))
    print("Response StatusLine: " + rest.responseStatusText())
    print("Response Header:")
    print(rest.responseHeader())
    print("Response Body:")
    print(responseBody)
    sys.exit()

xml.LoadXml(responseBody)
print(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 < count_i :
    xml.put_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