Lua

Populi Search People

See more Populi Examples

Demonstrates the Populi searchPeople task. Lua

local chilkat = require("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.
local xml = chilkat.Xml.new()
local success = xml:load_xml_file("qa_data/tokens/populi_token.xml")
local accessKey = xml:get_child_content("access_key")
if not xml.last_method_success then
    print("Did not find the access_key")
    return
end

local rest = chilkat.Rest.new()

-- 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.
local bAutoReconnect = true
success = rest:connect("yourcollege.populi.co", 443, true, bAutoReconnect)
if not success then
    print(rest.last_error_text)
    return
end

rest.authorization = accessKey

rest:add_query_param("task", "searchPeople")
rest:add_query_param("search_term", "Robert")
rest:add_query_param("limit", "10")

local responseBody = rest:full_request_form_url_encoded("POST", "/api/index.php")
if not rest.last_method_success then
    print(rest.last_error_text)
    return
end

-- We should expect a 200 response if successful.
if rest.response_status_code ~= 200 then
    print("Request Header: ")
    print(rest.last_request_header)
    print("----")
    print("Response StatusCode = " .. rest.response_status_code)
    print("Response StatusLine: " .. rest.response_status_text)
    print("Response Header:")
    print(rest.response_header)
    print("Response Body:")
    print(responseBody)
    return
end

xml:load_xml(responseBody)
print(xml:get_xml())

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

local id = 0
local first_name = ""
local last_name = ""
local middle_name = ""
local preferred_name = ""
local is_user = 0
local primary_email = ""

local i = 0
local count_i = xml:num_children_having_tag("person")
while i < count_i do
    xml.i = i
    id = xml:get_child_int_value("person[i]|id")
    first_name = xml:get_child_content("person[i]|first_name")
    last_name = xml:get_child_content("person[i]|last_name")
    middle_name = xml:get_child_content("person[i]|middle_name")
    preferred_name = xml:get_child_content("person[i]|preferred_name")
    is_user = xml:get_child_int_value("person[i]|is_user")
    primary_email = xml:get_child_content("person[i]|primary_email")
    i = i + 1
end