(JavaScript) Populi Search People

Demonstrates the Populi searchPeople task.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var 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.
var xml = new CkXml();
success = xml.LoadXmlFile("qa_data/tokens/populi_token.xml");
var accessKey = xml.GetChildContent("access_key");
if (xml.LastMethodSuccess !== true) {
    console.log("Did not find the access_key");
    return;
}

var rest = new 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.
var bAutoReconnect = true;
success = rest.Connect("yourcollege.populi.co",443,true,bAutoReconnect);
if (success !== true) {
    console.log(rest.LastErrorText);
    return;
}

rest.Authorization = accessKey;

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

var responseBody = rest.FullRequestFormUrlEncoded("POST","/api/index.php");
if (rest.LastMethodSuccess !== true) {
    console.log(rest.LastErrorText);
    return;
}

// We should expect a 200 response if successful.
if (rest.ResponseStatusCode !== 200) {
    console.log("Request Header: ");
    console.log(rest.LastRequestHeader);
    console.log("----");
    console.log("Response StatusCode = " + rest.ResponseStatusCode);
    console.log("Response StatusLine: " + rest.ResponseStatusText);
    console.log("Response Header:");
    console.log(rest.ResponseHeader);
    console.log("Response Body:");
    console.log(responseBody);
    return;
}

xml.LoadXml(responseBody);
console.log(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>

var i;
var count_i;
var id;
var first_name;
var last_name;
var middle_name;
var preferred_name;
var is_user;
var primary_email;

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;
}