PHP ActiveX

Populi Add Financial Aid Disbursement

See more Populi Examples

Demonstrates the Populi addFinancialAidDisbursement task. PHP ActiveX

<?php

$success = 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.
$xml = new COM("Chilkat.Xml");
$success = $xml->LoadXmlFile('qa_data/tokens/populi_token.xml');
$accessKey = $xml->getChildContent('access_key');
if ($xml->LastMethodSuccess != 1) {
    print 'Did not find the access_key' . "\n";
    exit;
}

$rest = new COM("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.
$bAutoReconnect = 1;
$success = $rest->Connect('yourcollege.populi.co',443,1,$bAutoReconnect);
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

$rest->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->LastMethodSuccess != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

// We should expect a 200 response if successful.
if ($rest->ResponseStatusCode != 200) {
    print 'Request Header: ' . "\n";
    print $rest->LastRequestHeader . "\n";
    print '----' . "\n";
    print 'Response StatusCode = ' . $rest->ResponseStatusCode . "\n";
    print 'Response StatusLine: ' . $rest->ResponseStatusText . "\n";
    print 'Response Header:' . "\n";
    print $rest->ResponseHeader . "\n";
    print 'Response Body:' . "\n";
    print $responseBody . "\n";
    exit;
}

$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');

?>