Swift

Populi Search People

See more Populi Examples

Demonstrates the Populi searchPeople task. Swift

func chilkatTest() {
    var success: Bool = 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.
    let xml = CkoXml()!
    success = xml.loadFile(path: "qa_data/tokens/populi_token.xml")
    var accessKey: String? = xml.getChildContent(tagPath: "access_key")
    if xml.lastMethodSuccess != true {
        print("Did not find the access_key")
        return
    }

    let rest = CkoRest()!

    // 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: Bool = true
    success = rest.connect(hostname: "yourcollege.populi.co", port: 443, tls: true, autoReconnect: bAutoReconnect)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    rest.authorization = accessKey

    rest.addQueryParam(name: "task", value: "searchPeople")
    rest.addQueryParam(name: "search_term", value: "Robert")
    rest.addQueryParam(name: "limit", value: "10")

    var responseBody: String? = rest.fullRequestFormUrlEncoded(httpVerb: "POST", uriPath: "/api/index.php")
    if rest.lastMethodSuccess != true {
        print("\(rest.lastErrorText!)")
        return
    }

    // We should expect a 200 response if successful.
    if rest.responseStatusCode.intValue != 200 {
        print("Request Header: ")
        print("\(rest.lastRequestHeader!)")
        print("----")
        print("Response StatusCode = \(rest.responseStatusCode.intValue)")
        print("Response StatusLine: \(rest.responseStatusText!)")
        print("Response Header:")
        print("\(rest.responseHeader!)")
        print("Response Body:")
        print("\(responseBody!)")
        return
    }

    xml.load(xmlData: 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>

    var i: Int
    var count_i: Int
    var id: Int
    var first_name: String?
    var last_name: String?
    var middle_name: String?
    var preferred_name: String?
    var is_user: Int
    var primary_email: String?

    i = 0
    count_i = xml.numChildrenHavingTag(tag: "person").intValue
    while i < count_i {
        xml.i = i
        id = xml.getChildIntValue(tagPath: "person[i]|id").intValue
        first_name = xml.getChildContent(tagPath: "person[i]|first_name")
        last_name = xml.getChildContent(tagPath: "person[i]|last_name")
        middle_name = xml.getChildContent(tagPath: "person[i]|middle_name")
        preferred_name = xml.getChildContent(tagPath: "person[i]|preferred_name")
        is_user = xml.getChildIntValue(tagPath: "person[i]|is_user").intValue
        primary_email = xml.getChildContent(tagPath: "person[i]|primary_email")
        i = i + 1
    }


}