Dart

Populi Add Financial Aid Disbursement

See more Populi Examples

Demonstrates the Populi addFinancialAidDisbursement task. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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.
  final xml = CkXml();
  xml.loadXmlFile('qa_data/tokens/populi_token.xml');
  final String accessKey;
  try {
    accessKey = xml.getChildContent('access_key');
  } on ChilkatException {
    print('Did not find the access_key');
    return;
  }

  final rest = CkRest();

  // 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.
  final bAutoReconnect = true;
  try {
    rest.connect('yourcollege.populi.co', 443, true, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

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

  final String responseBody;
  try {
    responseBody = rest.fullRequestFormUrlEncoded('POST', '/api/index.php');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // We should expect a 200 response if successful.
  if (rest.responseStatusCode != 200) {
    print('Request Header: ');
    print(rest.lastRequestHeader);
    print('----');
    print('Response StatusCode = ${rest.responseStatusCode}');
    print('Response StatusLine: ${rest.responseStatusText}');
    print('Response Header:');
    print(rest.responseHeader);
    print('Response Body:');
    print(responseBody);
    return;
  }

  xml.loadXml(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>

  final disbursement = xml.getChildIntValue('disbursement');
}