Visual FoxPro

Populi Add Financial Aid Disbursement

See more Populi Examples

Demonstrates the Populi addFinancialAidDisbursement task. Visual FoxPro

LOCAL lnSuccess
LOCAL loXml
LOCAL lcAccessKey
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL lcResponseBody
LOCAL lnDisbursement

lnSuccess = 0

* 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.
loXml = CreateObject('Chilkat.Xml')
lnSuccess = loXml.LoadXmlFile("qa_data/tokens/populi_token.xml")
lcAccessKey = loXml.GetChildContent("access_key")
IF (loXml.LastMethodSuccess <> 1) THEN
    ? "Did not find the access_key"
    RELEASE loXml
    CANCEL
ENDIF

loRest = CreateObject('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.
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("yourcollege.populi.co",443,1,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loXml
    RELEASE loRest
    CANCEL
ENDIF

loRest.Authorization = lcAccessKey

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

lcResponseBody = loRest.FullRequestFormUrlEncoded("POST","/api/index.php")
IF (loRest.LastMethodSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loXml
    RELEASE loRest
    CANCEL
ENDIF

* We should expect a 200 response if successful.
IF (loRest.ResponseStatusCode <> 200) THEN
    ? "Request Header: "
    ? loRest.LastRequestHeader
    ? "----"
    ? "Response StatusCode = " + STR(loRest.ResponseStatusCode)
    ? "Response StatusLine: " + loRest.ResponseStatusText
    ? "Response Header:"
    ? loRest.ResponseHeader
    ? "Response Body:"
    ? lcResponseBody
    RELEASE loXml
    RELEASE loRest
    CANCEL
ENDIF

loXml.LoadXml(lcResponseBody)
? loXml.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>

lnDisbursement = loXml.GetChildIntValue("disbursement")

RELEASE loXml
RELEASE loRest