Xojo Plugin

Populi Add Financial Aid Disbursement

See more Populi Examples

Demonstrates the Populi addFinancialAidDisbursement task. Xojo Plugin

Dim success As Boolean
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.
Dim xml As New Chilkat.Xml
success = xml.LoadXmlFile("qa_data/tokens/populi_token.xml")
Dim accessKey As String
accessKey = xml.GetChildContent("access_key")
If (xml.LastMethodSuccess <> True) Then
    System.DebugLog("Did not find the access_key")
    Return
End If

Dim rest As New Chilkat.Rest

// 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.
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("yourcollege.populi.co",443,True,bAutoReconnect)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

rest.Authorization = accessKey

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

Dim responseBody As String
responseBody = rest.FullRequestFormUrlEncoded("POST","/api/index.php")
If (rest.LastMethodSuccess <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// We should expect a 200 response if successful.
If (rest.ResponseStatusCode <> 200) Then
    System.DebugLog("Request Header: ")
    System.DebugLog(rest.LastRequestHeader)
    System.DebugLog("----")
    System.DebugLog("Response StatusCode = " + Str(rest.ResponseStatusCode))
    System.DebugLog("Response StatusLine: " + rest.ResponseStatusText)
    System.DebugLog("Response Header:")
    System.DebugLog(rest.ResponseHeader)
    System.DebugLog("Response Body:")
    System.DebugLog(responseBody)
    Return
End If

success = xml.LoadXml(responseBody)
System.DebugLog(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>

Dim disbursement As Int32
disbursement = xml.GetChildIntValue("disbursement")