AidType

The AidType object

The AidType object looks like this in JSON:

{
    "object": "aid_type",
    "id": 1,
    "startyear": 1,
    "endyear": null,
    "name": "Pell Grant",
    "abbrv": "PELL",
    "cod_abbrv": "PELL",
    "title_iv": true,
    "type": "grant",
    "is_scholarship": false,
    "source": "federal",
    "multiplier": null,
    "federal_aid_id": null,
    "need_based": true,
    "count_against_need": true,
    "report_on_1098t": true,
    "non_eligible_fee_aid": false,
    "count_as_tuition_discount": false,
    "counts_as_efa": true,
    "only_allow_whole_dollar_amounts": false,
    "allow_partial_acceptance": false,
    "require_enrollment_verification": false,
    "status": "active",
    "veterans_benefits": false,
    "external_id": null,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
startyear	Yes	int
endyear	Yes	int
name	Yes	text (100)
abbrv	Yes	text (25)
cod_abbrv	No	text (100)
title_iv	No	bool
type	Yes	enum (grant, loan, work_study)
is_scholarship	Yes	bool
source	Yes	enum (federal, state, institution, private, employer, other)
multiplier	No	decimal
federal_aid_id	No	int
need_based	Yes	bool
count_against_need	Yes	bool
report_on_1098t	Yes	bool
non_eligible_fee_aid	Yes	bool
count_as_tuition_discount	Yes	bool
counts_as_efa	Yes	bool
only_allow_whole_dollar_amounts	Yes	bool
allow_partial_acceptance	No	bool
require_enrollment_verification	Yes	bool
status	Yes	enum (active, retired)
veterans_benefits	Yes	bool
external_id	No	text (100)
sandbox	No	bool

index

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/aidtypes',
 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/aidtypes"), 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/aidtypes');
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": 12,
    "results": 12,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "aid_type",
            "id": 1,
            "startyear": 1,
            "endyear": null,
            "name": "Pell Grant",
            "abbrv": "PELL",
            "cod_abbrv": "PELL",
            "title_iv": true,
            "type": "grant",
            "is_scholarship": false,
            "source": "federal",
            "multiplier": null,
            "federal_aid_id": null,
            "need_based": true,
            "count_against_need": true,
            "report_on_1098t": true,
            "non_eligible_fee_aid": false,
            "count_as_tuition_discount": false,
            "counts_as_efa": true,
            "only_allow_whole_dollar_amounts": false,
            "allow_partial_acceptance": false,
            "require_enrollment_verification": false,
            "status": "active",
            "veterans_benefits": false,
            "external_id": null
        }
    ],
    "sandbox": true
}

Retrieves all AidType objects.

HTTP Request

GET /aidtypes

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/aidtypes/(aidtype)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/aidtypes/(aidtype)',
 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/aidtypes/(aidtype)"), 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/aidtypes/(aidtype)');
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_type",
    "id": 1,
    "startyear": 1,
    "endyear": null,
    "name": "Pell Grant",
    "abbrv": "PELL",
    "cod_abbrv": "PELL",
    "title_iv": true,
    "type": "grant",
    "is_scholarship": false,
    "source": "federal",
    "multiplier": null,
    "federal_aid_id": null,
    "need_based": true,
    "count_against_need": true,
    "report_on_1098t": true,
    "non_eligible_fee_aid": false,
    "count_as_tuition_discount": false,
    "counts_as_efa": true,
    "only_allow_whole_dollar_amounts": false,
    "allow_partial_acceptance": false,
    "require_enrollment_verification": false,
    "status": "active",
    "veterans_benefits": false,
    "external_id": null,
    "sandbox": true
}

Retrieves a specific AidType object.

HTTP Request

GET /aidtypes/(aidtype)

Parameters

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

Expandable Properties

account
origination_fees
percent_bases

Permissions

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

Financial Aid