AidClassification

The AidClassification object

The AidClassification object looks like this in JSON:

{
    "object": "aid_classification",
    "id": 6,
    "name": "Arc Welding",
    "year_coa_on_campus": 900,
    "year_coa_off_campus": null,
    "year_coa_off_campus_with_parents": 900,
    "program_coa_on_campus": 900,
    "program_coa_off_campus": null,
    "program_coa_off_campus_with_parents": null,
    "enrollment": "full_time",
    "months": 9,
    "auto_expand_award_dates": false,
    "status": "active",
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
name	Yes	text (100)
year_coa_on_campus	No	decimal
year_coa_off_campus	No	decimal
year_coa_off_campus_with_parents	No	decimal
program_coa_on_campus	No	decimal
program_coa_off_campus	No	decimal
program_coa_off_campus_with_parents	No	decimal
enrollment	No	enum (full_time, three_quarter_time, half_time, less_than_half_time)
months	No	int
auto_expand_award_dates	No	bool
status	Yes	enum (active, retired)
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/aidclassifications" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/aidclassifications',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/aidclassifications',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/aidclassifications"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/aidclassifications');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "list",
    "count": 1,
    "results": 1,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "aid_classification",
            "id": 6,
            "name": "Arc Welding",
            "year_coa_on_campus": 900,
            "year_coa_off_campus": null,
            "year_coa_off_campus_with_parents": 900,
            "program_coa_on_campus": 900,
            "program_coa_off_campus": null,
            "program_coa_off_campus_with_parents": null,
            "enrollment": "full_time",
            "months": 9,
            "auto_expand_award_dates": false,
            "status": "active"
        }
    ],
    "sandbox": true
}

Retrieves all AidClassification objects.

HTTP Request

GET /aidclassifications

Parameters

None

Permissions

One of the following roles is required to call this method:

Student Billing
Financial Admin
Financial Auditor
Financial Aid

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/aidclassifications/(aidclassification)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/aidclassifications/(aidclassification)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/aidclassifications/(aidclassification)',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/aidclassifications/(aidclassification)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/aidclassifications/(aidclassification)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_classification",
    "id": 6,
    "name": "Arc Welding",
    "year_coa_on_campus": 900,
    "year_coa_off_campus": null,
    "year_coa_off_campus_with_parents": 900,
    "program_coa_on_campus": 900,
    "program_coa_off_campus": null,
    "program_coa_off_campus_with_parents": null,
    "enrollment": "full_time",
    "months": 9,
    "auto_expand_award_dates": false,
    "status": "active",
    "sandbox": true
}

Retrieves a specific AidClassification object.

HTTP Request

GET /aidclassifications/(aidclassification)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Expandable Properties

coa_categories

Permissions

One of the following roles is required to call this method:

Financial Aid