Objective-C

Populi Add Financial Aid Disbursement

See more Populi Examples

Demonstrates the Populi addFinancialAidDisbursement task. Objective-C

#import <CkoXml.h>
#import <NSString.h>
#import <CkoRest.h>

BOOL success = NO;

// 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.
CkoXml *xml = [[CkoXml alloc] init];
success = [xml LoadXmlFile: @"qa_data/tokens/populi_token.xml"];
NSString *accessKey = [xml GetChildContent: @"access_key"];
if (xml.LastMethodSuccess != YES) {
    NSLog(@"%@",@"Did not find the access_key");
    return;
}

CkoRest *rest = [[CkoRest alloc] init];

// 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.
BOOL bAutoReconnect = YES;
success = [rest Connect: @"yourcollege.populi.co" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: bAutoReconnect];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

rest.Authorization = accessKey;

[rest AddQueryParam: @"task" value: @"addFinancialAidDisbursement"];
[rest AddQueryParam: @"person_id" value: @"12345678"];
[rest AddQueryParam: @"award_id" value: @"555555"];
[rest AddQueryParam: @"academic_term_id" value: @"123"];
[rest AddQueryParam: @"scheduled_date" value: @"2019-10-10"];
[rest AddQueryParam: @"amount" value: @"12345"];

NSString *responseBody = [rest FullRequestFormUrlEncoded: @"POST" uriPath: @"/api/index.php"];
if (rest.LastMethodSuccess != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

// We should expect a 200 response if successful.
if ([rest.ResponseStatusCode intValue] != 200) {
    NSLog(@"%@",@"Request Header: ");
    NSLog(@"%@",rest.LastRequestHeader);
    NSLog(@"%@",@"----");
    NSLog(@"%@%d",@"Response StatusCode = ",[rest.ResponseStatusCode intValue]);
    NSLog(@"%@%@",@"Response StatusLine: ",rest.ResponseStatusText);
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",rest.ResponseHeader);
    NSLog(@"%@",@"Response Body:");
    NSLog(@"%@",responseBody);
    return;
}

[xml LoadXml: responseBody];
NSLog(@"%@",[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>

int disbursement;
disbursement = [[xml GetChildIntValue: @"disbursement"] intValue];