(Ruby) Populi Add Financial Aid Disbursement

Demonstrates the Populi addFinancialAidDisbursement task.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

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.
xml = Chilkat::CkXml.new()
success = xml.LoadXmlFile("qa_data/tokens/populi_token.xml")
accessKey = xml.getChildContent("access_key")
if (xml.get_LastMethodSuccess() != true)
    print "Did not find the access_key" + "\n";
    exit
end

rest = Chilkat::CkRest.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.
bAutoReconnect = true
success = rest.Connect("yourcollege.populi.co",443,true,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

rest.put_Authorization(accessKey)

rest.AddQueryParam("task","addFinancialAidDisbursement")
rest.AddQueryParam("person_id","12345678")
rest.AddQueryParam("award_id","555555")
rest.AddQueryParam("academic_term_id","123")
rest.AddQueryParam("scheduled_date","2019-10-10")
rest.AddQueryParam("amount","12345")

responseBody = rest.fullRequestFormUrlEncoded("POST","/api/index.php")
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

# We should expect a 200 response if successful.
if (rest.get_ResponseStatusCode() != 200)
    print "Request Header: " + "\n";
    print rest.lastRequestHeader() + "\n";
    print "----" + "\n";
    print "Response StatusCode = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "Response StatusLine: " + rest.responseStatusText() + "\n";
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print responseBody + "\n";
    exit
end

xml.LoadXml(responseBody)
print xml.getXml() + "\n";

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

disbursement = xml.GetChildIntValue("disbursement")