Swift

Populi Add Financial Aid Disbursement

See more Populi Examples

Demonstrates the Populi addFinancialAidDisbursement 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: "addFinancialAidDisbursement")
    rest.addQueryParam(name: "person_id", value: "12345678")
    rest.addQueryParam(name: "award_id", value: "555555")
    rest.addQueryParam(name: "academic_term_id", value: "123")
    rest.addQueryParam(name: "scheduled_date", value: "2019-10-10")
    rest.addQueryParam(name: "amount", value: "12345")

    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"?>
    // <result>
    // 	<disbursement>123456</disbursement>
    // </result>

    var disbursement: Int
    disbursement = xml.getChildIntValue(tagPath: "disbursement").intValue

}