(Lianja) Populi Search People

Demonstrates the Populi searchPeople task.

Chilkat Lianja Extension Download Chilkat Lianja Extension

// 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","searchPeople")
loRest.AddQueryParam("search_term","Robert")
loRest.AddQueryParam("limit","10")

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="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
lnCount_i = loXml.NumChildrenHavingTag("person")
do while i < lnCount_i
    loXml.I = i
    lnId = loXml.GetChildIntValue("person[i]|id")
    lcFirst_name = loXml.GetChildContent("person[i]|first_name")
    lcLast_name = loXml.GetChildContent("person[i]|last_name")
    lcMiddle_name = loXml.GetChildContent("person[i]|middle_name")
    lcPreferred_name = loXml.GetChildContent("person[i]|preferred_name")
    lnIs_user = loXml.GetChildIntValue("person[i]|is_user")
    lcPrimary_email = loXml.GetChildContent("person[i]|primary_email")
    i = i + 1
enddo


release loXml
release loRest