AidApplication

The AidApplication object

The AidApplication object looks like this in JSON:

{
    "object": "aid_application",
    "id": 6,
    "student_id": 35,
    "aid_year_id": 3,
    "aid_classification_id": 6,
    "auto_expand_award_dates": false,
    "parental_data_missing": false,
    "dependency": "independent",
    "enrollment": "full_time",
    "enrollment_intensity": false,
    "enrollment_status_effective_date": null,
    "program_months": 9,
    "year_coa": 10000,
    "program_coa": 10000,
    "year_efc": 10000,
    "program_efc": 10000,
    "institutional_sai": 9000,
    "verification": "selected_by_college",
    "verification_status": "in_progress",
    "verification_group": null,
    "verification_exempt_reason": null,
    "status": "in_progress",
    "assigned_to": 2921,
    "student_agi": 0,
    "parents_agi": 0,
    "auto_zero_efc": false,
    "fisap_total_income": null,
    "legal_residence_state": null,
    "housing": null,
    "award_letter_layout_id": null,
    "last_isir_id": null,
    "last_isir_transaction_date": null,
    "cod_student_level_code": null,
    "cod_academic_year_start_date": null,
    "cod_academic_year_end_date": null,
    "cod_degree_id": null,
    "cod_program_length": null,
    "cod_program_length_units": null,
    "cod_program_credential_level": null,
    "cod_special_program": null,
    "cod_weeks_programs_academic_year": null,
    "cod_default_overpay_code": null,
    "cod_student_eligibility_code": null,
    "cod_ability_to_benefit_administrator_code": null,
    "cod_ability_to_benefit_test_code": null,
    "cod_ability_to_benefit_state_code": null,
    "cod_ability_to_benefit_date": null,
    "cod_program_cip_code": null,
    "cod_additional_unsubsidized_eligibility": false,
    "cod_hppa_indicator": false,
    "cod_additional_pell_eligibility": false,
    "cod_campus_id": null,
    "updated_on": null,
    "added_at": "2011-05-04T23:15:23+00:00",
    "added_by_id": 2921,
    "updated_at": null,
    "updated_by_id": 2011,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
student_id	No	int
aid_year_id	No	int
aid_classification_id	No	int
auto_expand_award_dates	No	bool
parental_data_missing	No	bool
dependency	No	enum (dependent, independent)
enrollment	Yes	enum (full_time, three_quarter_time, half_time, less_than_half_time)
enrollment_intensity	No	bool
enrollment_status_effective_date	No	date
program_months	No	int
year_coa	Yes	decimal
program_coa	Yes	decimal
year_efc	Yes	decimal
program_efc	Yes	decimal
institutional_sai	No	decimal
verification	No	enum (selected_by_college, selected_by_government)
verification_status	No	enum (in_progress, completed, rejected, exempted)
verification_group	No	text (200)
verification_exempt_reason	No	text (1000)
status	Yes	enum (setup, in_progress, completed, needs_attention, canceled, deleted)
assigned_to	No	int
student_agi	Yes	decimal
parents_agi	Yes	decimal
auto_zero_efc	No	bool
fisap_total_income	No	decimal
legal_residence_state	No	text (3)
housing	No	enum (on_campus, with_parent, off_campus, on_campus_with_dependents)
award_letter_layout_id	No	int
last_isir_id	No	int
last_isir_transaction_date	No	date
cod_student_level_code	No	int
cod_academic_year_start_date	No	date
cod_academic_year_end_date	No	date
cod_degree_id	No	int
cod_program_length	No	decimal
cod_program_length_units	No	enum (years, months, weeks)
cod_program_credential_level	No	int
cod_special_program	No	char
cod_weeks_programs_academic_year	No	decimal
cod_default_overpay_code	No	char
cod_student_eligibility_code	No	char
cod_ability_to_benefit_administrator_code	No	char
cod_ability_to_benefit_test_code	No	char
cod_ability_to_benefit_state_code	No	char
cod_ability_to_benefit_date	No	date
cod_program_cip_code	No	text (20)
cod_additional_unsubsidized_eligibility	No	bool
cod_hppa_indicator	No	bool
cod_additional_pell_eligibility	No	bool
cod_campus_id	No	int
updated_on	No	date
added_at	No	datetime
added_by_id	No	int
updated_at	No	datetime
updated_by_id	No	int
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/aidapplications" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": {"0":{"logic":"ALL","fields":[{"name":"assigned_to","value":1,"positive":1}]}}
}' \

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/aidapplications',
 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/aidapplications"), 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/aidapplications');
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": 200,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "aid_application",
            "id": 6,
            "student_id": 35,
            "aid_year_id": 3,
            "aid_classification_id": 6,
            "auto_expand_award_dates": false,
            "parental_data_missing": false,
            "dependency": "independent",
            "enrollment": "full_time",
            "enrollment_intensity": false,
            "enrollment_status_effective_date": null,
            "program_months": 9,
            "year_coa": 10000,
            "program_coa": 10000,
            "year_efc": 10000,
            "program_efc": 10000,
            "institutional_sai": 9000,
            "verification": "selected_by_college",
            "verification_status": "in_progress",
            "verification_group": null,
            "verification_exempt_reason": null,
            "status": "in_progress",
            "assigned_to": 2921,
            "student_agi": 0,
            "parents_agi": 0,
            "auto_zero_efc": false,
            "fisap_total_income": null,
            "legal_residence_state": null,
            "housing": null,
            "award_letter_layout_id": null,
            "last_isir_id": null,
            "last_isir_transaction_date": null,
            "cod_student_level_code": null,
            "cod_academic_year_start_date": null,
            "cod_academic_year_end_date": null,
            "cod_degree_id": null,
            "cod_program_length": null,
            "cod_program_length_units": null,
            "cod_program_credential_level": null,
            "cod_special_program": null,
            "cod_weeks_programs_academic_year": null,
            "cod_default_overpay_code": null,
            "cod_student_eligibility_code": null,
            "cod_ability_to_benefit_administrator_code": null,
            "cod_ability_to_benefit_test_code": null,
            "cod_ability_to_benefit_state_code": null,
            "cod_ability_to_benefit_date": null,
            "cod_program_cip_code": null,
            "cod_additional_unsubsidized_eligibility": false,
            "cod_hppa_indicator": false,
            "cod_additional_pell_eligibility": false,
            "cod_campus_id": null,
            "updated_on": null,
            "added_at": "2011-05-04T23:15:23+00:00",
            "added_by_id": 2921,
            "updated_at": null,
            "updated_by_id": 2011,
            "report_data": {
                "dummyid": "20220xx003",
                "lastname": "Miller",
                "firstname": "Dolce",
                "student_name": "Dolce Miller",
                "assigned_to_name": null,
                "classification_name": "Arc Welding",
                "num_components": 1,
                "num_components_accepted": 1,
                "completion_percent": "100",
                "need": "0.00",
                "added_at_local": "2011-05-04 16:15:23",
                "admitted_date": null,
                "row_id": 6
            }
        }
    ],
    "sandbox": true
}

Retrieves all AidApplication objects that match given filter conditions.

HTTP Request

GET /aidapplications

Parameters

Name	Required	Data Type	Description
aid_year_id	No	int	To filter results to only aid applications in a particular Aid Year.
filter	No	mixed	See available filter conditions
page	No	int	The page of results to return if more than 200 records are found.

Expandable Properties

components
monthly_efcs
questions

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name	Type
student	object_id
status	enum
verification_status	choice
dependency	enum
assigned_to	aidofficer
updated	datetime
classification	object id
coa	decimal
efc	decimal
need	decimal
completion	integer
campus	object id
program	object id
aid_authorization	aidauthorization
has_not_set_aid_authorization	aidauthorizationunset
tag	tag
custom_field	custom
has_active_student_role	enum (yes, no)
isir_imported_at	datetime

Permissions

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

Financial Admin
Student Billing
Financial Auditor
Financial Aid

index (person)

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/aidapplications',
 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/people/(person)/aidapplications"), 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/people/(person)/aidapplications');
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_application",
            "id": 6,
            "student_id": 35,
            "aid_year_id": 3,
            "aid_classification_id": 6,
            "auto_expand_award_dates": false,
            "parental_data_missing": false,
            "dependency": "independent",
            "enrollment": "full_time",
            "enrollment_intensity": false,
            "enrollment_status_effective_date": null,
            "program_months": 9,
            "year_coa": 10000,
            "program_coa": 10000,
            "year_efc": 10000,
            "program_efc": 10000,
            "institutional_sai": 9000,
            "verification": "selected_by_college",
            "verification_status": "in_progress",
            "verification_group": null,
            "verification_exempt_reason": null,
            "status": "in_progress",
            "assigned_to": 2921,
            "student_agi": 0,
            "parents_agi": 0,
            "auto_zero_efc": false,
            "fisap_total_income": null,
            "legal_residence_state": null,
            "housing": null,
            "award_letter_layout_id": null,
            "last_isir_id": null,
            "last_isir_transaction_date": null,
            "cod_student_level_code": null,
            "cod_academic_year_start_date": null,
            "cod_academic_year_end_date": null,
            "cod_degree_id": null,
            "cod_program_length": null,
            "cod_program_length_units": null,
            "cod_program_credential_level": null,
            "cod_special_program": null,
            "cod_weeks_programs_academic_year": null,
            "cod_default_overpay_code": null,
            "cod_student_eligibility_code": null,
            "cod_ability_to_benefit_administrator_code": null,
            "cod_ability_to_benefit_test_code": null,
            "cod_ability_to_benefit_state_code": null,
            "cod_ability_to_benefit_date": null,
            "cod_program_cip_code": null,
            "cod_additional_unsubsidized_eligibility": false,
            "cod_hppa_indicator": false,
            "cod_additional_pell_eligibility": false,
            "cod_campus_id": null,
            "updated_on": null,
            "added_at": "2011-05-04T23:15:23+00:00",
            "added_by_id": 2921,
            "updated_at": null,
            "updated_by_id": 2011
        }
    ],
    "sandbox": true
}

Retrieves all AidApplication objects tied to a specific Person.

HTTP Request

GET /people/(person)/aidapplications

Parameters

None

Expandable Properties

components
monthly_efcs
questions

Permissions

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

Staff

create

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidapplications" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X POST
-d '{
    "aid_year_id": 3,
    "status": "setup",
    "enrollment": "full_time"
}' \

require 'httparty'
response = HTTParty.post(
 'https://yourschool.populiweb.com/api2/people/(person)/aidapplications',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
 body: {
  :aid_year_id => 3,
  :status => 'setup',
  :enrollment => 'full_time'
 }.to_json
)
puts response.body

import requests
response = requests.post(
 'https://yourschool.populiweb.com/api2/people/(person)/aidapplications',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
 json={
  'aid_year_id': 3,
  'status': 'setup',
  'enrollment': 'full_time'
 }
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/people/(person)/aidapplications"), Method.Post);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
request.AddJsonBody(new {
  aid_year_id = 3,
  status = "setup",
  enrollment = "full_time"
});
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/people/(person)/aidapplications');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode([
  'aid_year_id' => 3,
  'status' => 'setup',
  'enrollment' => 'full_time'
]));
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_application",
    "id": 7,
    "student_id": 12,
    "aid_year_id": 3,
    "aid_classification_id": null,
    "auto_expand_award_dates": false,
    "parental_data_missing": false,
    "dependency": null,
    "enrollment": "full_time",
    "enrollment_intensity": false,
    "enrollment_status_effective_date": null,
    "program_months": null,
    "year_coa": 0,
    "program_coa": 0,
    "year_efc": 0,
    "program_efc": 0,
    "institutional_sai": null,
    "verification": null,
    "verification_status": null,
    "verification_group": null,
    "verification_exempt_reason": null,
    "status": "setup",
    "assigned_to": null,
    "student_agi": 0,
    "parents_agi": 0,
    "auto_zero_efc": false,
    "fisap_total_income": 0,
    "legal_residence_state": null,
    "housing": null,
    "award_letter_layout_id": null,
    "last_isir_id": null,
    "last_isir_transaction_date": null,
    "cod_student_level_code": null,
    "cod_academic_year_start_date": null,
    "cod_academic_year_end_date": null,
    "cod_degree_id": 2,
    "cod_program_length": null,
    "cod_program_length_units": null,
    "cod_program_credential_level": null,
    "cod_special_program": null,
    "cod_weeks_programs_academic_year": null,
    "cod_default_overpay_code": null,
    "cod_student_eligibility_code": null,
    "cod_ability_to_benefit_administrator_code": null,
    "cod_ability_to_benefit_test_code": null,
    "cod_ability_to_benefit_state_code": null,
    "cod_ability_to_benefit_date": null,
    "cod_program_cip_code": null,
    "cod_additional_unsubsidized_eligibility": false,
    "cod_hppa_indicator": false,
    "cod_additional_pell_eligibility": false,
    "cod_campus_id": null,
    "updated_on": null,
    "added_at": "2026-07-25T16:24:05+00:00",
    "added_by_id": 22,
    "updated_at": "2026-07-25T16:24:05+00:00",
    "updated_by_id": 22,
    "sandbox": true
}

Creates a new AidApplication object.

HTTP Request

POST /people/(person)/aidapplications

Parameters

Name	Required	Data Type
aid_year_id	Yes	int
status	Yes	enum (setup, in_progress, completed, needs_attention, canceled, deleted)
enrollment	Yes	enum (full_time, three_quarter_time, half_time, less_than_half_time)
assigned_to	No	int
dependency	No	enum (dependent, independent)
student_aid_class_id	No	int
program_months	No	int
year_coa	No	decimal
program_coa	No	decimal
year_efc	No	decimal
program_efc	No	decimal
student_agi	No	decimal
parents_agi	No	decimal
legal_residence_state	No	text (3)
verification	No	enum (selected_by_college, selected_by_government)
verification_status	No	enum (in_progress, completed, rejected, exempted)
verification_group	No	text (200)
auto_zero_efc	No	bool
fisap_total_income	No	decimal
housing	No	enum (on_campus, with_parent, off_campus, on_campus_with_dependents)
coa_breakout_field	No	array of amounts indexed to CoaCateogry ids
component_ids	No	array of AidApplicationComponent ids
award_letter_layout_id	No	int
cod_ability_to_benefit_date	No	date
cod_ability_to_benefit_administrator_code	No	char
cod_ability_to_benefit_test_code	No	char
cod_ability_to_benefit_state_code	No	char
cod_student_eligibility_code	No	char
cod_default_overpay_code	No	char
cod_special_program	No	char
cod_program_credential_level	No	int
cod_weeks_programs_academic_year	No	decimal
cod_program_length_units	No	enum (years, months, weeks)
cod_program_length	No	decimal
cod_academic_year_end_date	No	date
cod_academic_year_start_date	No	date
cod_student_level_code	No	int
cod_program_cip_code	No	text (20)

Permissions

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

Financial Aid

show

Example code to call this method:

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

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

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/aidapplications/(aidapplication)',
 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/people/(person)/aidapplications/(aidapplication)"), 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/people/(person)/aidapplications/(aidapplication)');
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_application",
    "id": 6,
    "student_id": 35,
    "aid_year_id": 3,
    "aid_classification_id": 6,
    "auto_expand_award_dates": false,
    "parental_data_missing": false,
    "dependency": "independent",
    "enrollment": "full_time",
    "enrollment_intensity": false,
    "enrollment_status_effective_date": null,
    "program_months": 9,
    "year_coa": 10000,
    "program_coa": 10000,
    "year_efc": 10000,
    "program_efc": 10000,
    "institutional_sai": 9000,
    "verification": "selected_by_college",
    "verification_status": "in_progress",
    "verification_group": null,
    "verification_exempt_reason": null,
    "status": "in_progress",
    "assigned_to": 2921,
    "student_agi": 0,
    "parents_agi": 0,
    "auto_zero_efc": false,
    "fisap_total_income": null,
    "legal_residence_state": null,
    "housing": null,
    "award_letter_layout_id": null,
    "last_isir_id": null,
    "last_isir_transaction_date": null,
    "cod_student_level_code": null,
    "cod_academic_year_start_date": null,
    "cod_academic_year_end_date": null,
    "cod_degree_id": null,
    "cod_program_length": null,
    "cod_program_length_units": null,
    "cod_program_credential_level": null,
    "cod_special_program": null,
    "cod_weeks_programs_academic_year": null,
    "cod_default_overpay_code": null,
    "cod_student_eligibility_code": null,
    "cod_ability_to_benefit_administrator_code": null,
    "cod_ability_to_benefit_test_code": null,
    "cod_ability_to_benefit_state_code": null,
    "cod_ability_to_benefit_date": null,
    "cod_program_cip_code": null,
    "cod_additional_unsubsidized_eligibility": false,
    "cod_hppa_indicator": false,
    "cod_additional_pell_eligibility": false,
    "cod_campus_id": null,
    "updated_on": null,
    "added_at": "2011-05-04T23:15:23+00:00",
    "added_by_id": 2921,
    "updated_at": null,
    "updated_by_id": 2011,
    "sandbox": true
}

Retrieves a specific AidApplication object.

HTTP Request

GET /people/(person)/aidapplications/(aidapplication)

Parameters

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

Expandable Properties

components
monthly_efcs
questions

Permissions

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

Financial Auditor
Financial Aid

update

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidapplications/(aidapplication)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X PUT
-d '{
    "status": "completed",
    "enrollment": "half_time"
}' \

require 'httparty'
response = HTTParty.put(
 'https://yourschool.populiweb.com/api2/people/(person)/aidapplications/(aidapplication)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
 body: {
  :status => 'completed',
  :enrollment => 'half_time'
 }.to_json
)
puts response.body

import requests
response = requests.put(
 'https://yourschool.populiweb.com/api2/people/(person)/aidapplications/(aidapplication)',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
 json={
  'status': 'completed',
  'enrollment': 'half_time'
 }
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/people/(person)/aidapplications/(aidapplication)"), Method.Put);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
request.AddJsonBody(new {
  status = "completed",
  enrollment = "half_time"
});
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/people/(person)/aidapplications/(aidapplication)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode([
  'status' => 'completed',
  'enrollment' => 'half_time'
]));
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_application",
    "id": 7,
    "student_id": 12,
    "aid_year_id": 3,
    "aid_classification_id": null,
    "auto_expand_award_dates": false,
    "parental_data_missing": false,
    "dependency": null,
    "enrollment": "half_time",
    "enrollment_intensity": false,
    "enrollment_status_effective_date": null,
    "program_months": null,
    "year_coa": 0,
    "program_coa": 0,
    "year_efc": 0,
    "program_efc": 0,
    "institutional_sai": null,
    "verification": null,
    "verification_status": null,
    "verification_group": null,
    "verification_exempt_reason": null,
    "status": "completed",
    "assigned_to": null,
    "student_agi": 0,
    "parents_agi": 0,
    "auto_zero_efc": false,
    "fisap_total_income": 0,
    "legal_residence_state": null,
    "housing": null,
    "award_letter_layout_id": null,
    "last_isir_id": null,
    "last_isir_transaction_date": null,
    "cod_student_level_code": null,
    "cod_academic_year_start_date": null,
    "cod_academic_year_end_date": null,
    "cod_degree_id": 2,
    "cod_program_length": null,
    "cod_program_length_units": null,
    "cod_program_credential_level": null,
    "cod_special_program": null,
    "cod_weeks_programs_academic_year": null,
    "cod_default_overpay_code": null,
    "cod_student_eligibility_code": null,
    "cod_ability_to_benefit_administrator_code": null,
    "cod_ability_to_benefit_test_code": null,
    "cod_ability_to_benefit_state_code": null,
    "cod_ability_to_benefit_date": null,
    "cod_program_cip_code": null,
    "cod_additional_unsubsidized_eligibility": false,
    "cod_hppa_indicator": false,
    "cod_additional_pell_eligibility": false,
    "cod_campus_id": null,
    "updated_on": null,
    "added_at": "2026-07-25T16:24:05+00:00",
    "added_by_id": 22,
    "updated_at": "2026-07-25T16:24:05+00:00",
    "updated_by_id": 22,
    "sandbox": true
}

Updates an existing AidApplication object.

HTTP Request

PUT /people/(person)/aidapplications/(aidapplication)

Parameters

Name	Required	Data Type
status	Yes	enum (setup, in_progress, completed, needs_attention, canceled, deleted)
enrollment	Yes	enum (full_time, three_quarter_time, half_time, less_than_half_time)
assigned_to	No	int
dependency	No	enum (dependent, independent)
student_aid_class_id	No	int
program_months	No	int
year_coa	No	decimal
program_coa	No	decimal
year_efc	No	decimal
program_efc	No	decimal
student_agi	No	decimal
parents_agi	No	decimal
legal_residence_state	No	text (3)
verification	No	enum (selected_by_college, selected_by_government)
verification_status	No	enum (in_progress, completed, rejected, exempted)
verification_group	No	text (200)
auto_zero_efc	No	bool
fisap_total_income	No	decimal
housing	No	enum (on_campus, with_parent, off_campus, on_campus_with_dependents)
coa_breakout_field	No	array of amounts indexed to CoaCateogry ids
component_ids	No	array of AidApplicationComponent ids
award_letter_layout_id	No	int
cod_ability_to_benefit_date	No	date
cod_ability_to_benefit_administrator_code	No	char
cod_ability_to_benefit_test_code	No	char
cod_ability_to_benefit_state_code	No	char
cod_student_eligibility_code	No	char
cod_default_overpay_code	No	char
cod_special_program	No	char
cod_program_credential_level	No	int
cod_weeks_programs_academic_year	No	decimal
cod_program_length_units	No	enum (years, months, weeks)
cod_program_length	No	decimal
cod_academic_year_start_date	No	date
cod_academic_year_end_date	No	date
cod_student_level_code	No	int
cod_program_cip_code	No	text (20)

Permissions

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

Financial Aid

delete

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidapplications/(aidapplication)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X DELETE

require 'httparty'
response = HTTParty.delete(
 'https://yourschool.populiweb.com/api2/people/(person)/aidapplications/(aidapplication)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.delete(
 'https://yourschool.populiweb.com/api2/people/(person)/aidapplications/(aidapplication)',
 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/people/(person)/aidapplications/(aidapplication)"), Method.Delete);
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/people/(person)/aidapplications/(aidapplication)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_application",
    "id": 7,
    "deleted": true
}

Deletes an existing AidApplication object.

HTTP Request

DELETE /people/(person)/aidapplications/(aidapplication)

Parameters

No additional parameters are needed beyond the ID of the object to delete that appears in the URL.

Permissions

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

Financial Aid