NAV
shell ruby python csharp php

AidAward

The AidAward object

The AidAward object looks like this in JSON:

{
    "object": "aid_award",
    "id": 6,
    "student_id": 1,
    "aid_year_id": 1,
    "aid_type_id": 1,
    "sequence_number": 1,
    "original_accepted_amount": 1000,
    "award_limit": 1000,
    "max_amount": 1000,
    "net_amount": 1000,
    "multiplier": null,
    "auto_calc_percent_amount": false,
    "fee_percent": null,
    "status": "accepted",
    "loan_booked_on": null,
    "loan_payment_to_servicer_amount": 0,
    "loan_payment_to_servicer_date": null,
    "plus_loan_has_endorser": false,
    "plus_loan_endorser_amount": null,
    "plus_loan_credit_requirements_met": false,
    "loan_booked_cod_response_id": null,
    "year_coa": null,
    "cod_id": null,
    "cod_amount": 0,
    "cod_origination_fee_percent": null,
    "cod_start_date": null,
    "cod_end_date": null,
    "cod_student_level_code": null,
    "cod_academic_year_start_date": null,
    "cod_academic_year_end_date": null,
    "cod_program_length": null,
    "cod_program_length_units": null,
    "cod_program_credential_level": null,
    "enrollment_status_effective_date": null,
    "cod_special_program": null,
    "cod_weeks_programs_academic_year": null,
    "cod_program_cip_code": null,
    "cod_plus_application_id": null,
    "cod_borrower_id": null,
    "refunds_go_to": "student",
    "cod_most_recent_response_id": null,
    "cod_status": null,
    "cod_sync_logic": "automatic",
    "cod_syncable": true,
    "cod_syncable_errors": null,
    "cod_needs_sync": true,
    "cod_originated": false,
    "external_id": null,
    "esign_by_student_at": null,
    "esign_by_student_ip": null,
    "work_study_hours_per_week": null,
    "added_at": "2015-09-08T07:53:22+00:00",
    "added_by_id": 11,
    "sandbox": true
}
Attribute Required Data Type
id Yes int
student_id No int
aid_year_id Yes int
aid_type_id Yes int
sequence_number Yes int
original_accepted_amount Yes decimal
award_limit Yes decimal
max_amount Yes decimal
net_amount Yes decimal
multiplier No decimal
auto_calc_percent_amount Yes bool
fee_percent No decimal
status Yes enum (setup, offered, accepted, declined, canceled, deleted)
loan_booked_on No date
loan_payment_to_servicer_amount Yes decimal
loan_payment_to_servicer_date No date
plus_loan_has_endorser No bool
plus_loan_endorser_amount No decimal
plus_loan_credit_requirements_met Yes bool
loan_booked_cod_response_id No int
year_coa No decimal
cod_id No text (200)
cod_amount Yes decimal
cod_origination_fee_percent No decimal
cod_start_date No date
cod_end_date No date
cod_student_level_code No int
cod_academic_year_start_date No date
cod_academic_year_end_date No date
cod_program_length No decimal
cod_program_length_units No enum (years, months, weeks)
cod_program_credential_level No int
enrollment_status_effective_date No date
cod_special_program No char
cod_weeks_programs_academic_year No decimal
cod_program_cip_code No text (20)
cod_plus_application_id No int
cod_borrower_id No int
refunds_go_to Yes enum (student, borrower)
cod_most_recent_response_id No int
cod_status No enum (pending, accepted, rejected, corrected)
cod_sync_logic Yes enum (manual, automatic)
cod_syncable Yes bool
cod_syncable_errors No text
cod_needs_sync Yes bool
cod_originated Yes bool
external_id No text (50)
esign_by_student_at No datetime
esign_by_student_ip No text (60)
work_study_hours_per_week No decimal
added_at No datetime
added_by_id No int
sandbox No bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/aidawards" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
-d '{
    "filter": {"0":{"logic":"ALL","fields":[{"name":"net_amount","value":{"type":"RANGE","start":"10.5","end":"900.15"},"positive":1}]}}
}' \ 
require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/aidawards',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body
import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/aidawards',
 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/aidawards"), 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/aidawards');
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": 5,
    "results": 5,
    "results_per_page": 200,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "aid_award",
            "id": 8,
            "student_id": 16,
            "aid_year_id": 1,
            "aid_type_id": 9,
            "sequence_number": 1,
            "original_accepted_amount": 4000,
            "award_limit": 4000,
            "max_amount": 4000,
            "net_amount": 4000,
            "multiplier": null,
            "auto_calc_percent_amount": false,
            "fee_percent": null,
            "status": "accepted",
            "loan_booked_on": null,
            "loan_payment_to_servicer_amount": 0,
            "loan_payment_to_servicer_date": null,
            "plus_loan_has_endorser": false,
            "plus_loan_endorser_amount": null,
            "plus_loan_credit_requirements_met": false,
            "loan_booked_cod_response_id": null,
            "year_coa": null,
            "cod_id": null,
            "cod_amount": 0,
            "cod_origination_fee_percent": null,
            "cod_start_date": null,
            "cod_end_date": null,
            "cod_student_level_code": null,
            "cod_academic_year_start_date": null,
            "cod_academic_year_end_date": null,
            "cod_program_length": null,
            "cod_program_length_units": null,
            "cod_program_credential_level": null,
            "enrollment_status_effective_date": null,
            "cod_special_program": null,
            "cod_weeks_programs_academic_year": null,
            "cod_program_cip_code": null,
            "cod_plus_application_id": null,
            "cod_borrower_id": null,
            "refunds_go_to": "student",
            "cod_most_recent_response_id": null,
            "cod_status": null,
            "cod_sync_logic": "automatic",
            "cod_syncable": true,
            "cod_syncable_errors": null,
            "cod_needs_sync": true,
            "cod_originated": false,
            "external_id": null,
            "esign_by_student_at": null,
            "esign_by_student_ip": null,
            "work_study_hours_per_week": null,
            "added_at": "2015-09-09T07:53:22+00:00",
            "added_by_id": 11,
            "report_data": {
                "person_id": 16,
                "aid_name": "Institutional Grant",
                "aid_abbrv": "INST",
                "financial_aid_type": "GRANT",
                "is_scholarship": 0,
                "aid_source": "INSTITUTION",
                "firstname": "Abby",
                "lastname": "Admin",
                "amount_scheduled": "440.70",
                "amount_disbursed": "0.00",
                "row_id": 8
            }
        }
    ],
    "sandbox": true
}

Retrieves all AidAward objects that match given filter conditions.

HTTP Request

GET /aidawards

Parameters

Name Required Data Type Description
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

Filter Condition Parameters

These conditions can be used to narrow the results returned.

Name Type
aid_accepted_by_student bool
aid_amount decimal
aid_authorization aidauthorization
aid_year object id
award object id
award_percent percent
campus object id
classification object id
custom_field custom
disbursed decimal
has_active_student_role enum (yes, no)
net_amount decimal
setup_scheduled decimal
source choice
status enum
student object_id
student_decision date
tag tag
type awardtype
unapplied_scheduled_aid bool

Permissions

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

index_by_student

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/" \
-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)/aidawards/',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body
import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/',
 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)/aidawards/"), 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)/aidawards/');
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_award",
            "id": 10,
            "student_id": 12,
            "aid_year_id": 1,
            "aid_type_id": 9,
            "sequence_number": 2,
            "original_accepted_amount": 4000,
            "award_limit": 4000,
            "max_amount": 4000,
            "net_amount": 4000,
            "multiplier": null,
            "auto_calc_percent_amount": false,
            "fee_percent": null,
            "status": "accepted",
            "loan_booked_on": null,
            "loan_payment_to_servicer_amount": 0,
            "loan_payment_to_servicer_date": null,
            "plus_loan_has_endorser": false,
            "plus_loan_endorser_amount": null,
            "plus_loan_credit_requirements_met": false,
            "loan_booked_cod_response_id": null,
            "year_coa": null,
            "cod_id": null,
            "cod_amount": 0,
            "cod_origination_fee_percent": null,
            "cod_start_date": null,
            "cod_end_date": null,
            "cod_student_level_code": null,
            "cod_academic_year_start_date": null,
            "cod_academic_year_end_date": null,
            "cod_program_length": null,
            "cod_program_length_units": null,
            "cod_program_credential_level": null,
            "enrollment_status_effective_date": null,
            "cod_special_program": null,
            "cod_weeks_programs_academic_year": null,
            "cod_program_cip_code": null,
            "cod_plus_application_id": null,
            "cod_borrower_id": null,
            "refunds_go_to": "student",
            "cod_most_recent_response_id": null,
            "cod_status": null,
            "cod_sync_logic": "automatic",
            "cod_syncable": true,
            "cod_syncable_errors": null,
            "cod_needs_sync": true,
            "cod_originated": false,
            "external_id": null,
            "esign_by_student_at": null,
            "esign_by_student_ip": null,
            "work_study_hours_per_week": null,
            "added_at": "2015-09-09T07:53:22+00:00",
            "added_by_id": 11
        }
    ],
    "sandbox": true
}

HTTP Request

GET /people/(person)/aidawards/

Parameters

None

Permissions

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

create

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X POST
-d '{
    "aid_year_id": 3,
    "aid_type_id": 1,
    "status": "offered",
    "amount": 2000,
    "net_amount": 1950.45
}' \ 
require 'httparty'
response = HTTParty.post(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
 body: {
  :aid_year_id => 3,
  :aid_type_id => 1,
  :status => 'offered',
  :amount => 2000,
  :net_amount => 1950.45
 }.to_json
)
puts response.body
import requests
response = requests.post(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
 json={
  'aid_year_id': 3,
  'aid_type_id': 1,
  'status': 'offered',
  'amount': 2000,
  'net_amount': 1950.45
 }
)
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)/aidawards"), Method.Post);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
request.AddJsonBody(new {
  aid_year_id = 3,
  aid_type_id = 1,
  status = "offered",
  amount = 2000,
  net_amount = 1950.45
});
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)/aidawards');
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,
  'aid_type_id' => 1,
  'status' => 'offered',
  'amount' => 2000,
  'net_amount' => 1950.45
]));
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_award",
    "id": 11,
    "student_id": 12,
    "aid_year_id": 3,
    "aid_type_id": 1,
    "sequence_number": 1,
    "original_accepted_amount": 1950.45,
    "award_limit": 2000,
    "max_amount": 2000,
    "net_amount": 1950.45,
    "multiplier": null,
    "auto_calc_percent_amount": false,
    "fee_percent": null,
    "status": "offered",
    "loan_booked_on": null,
    "loan_payment_to_servicer_amount": 0,
    "loan_payment_to_servicer_date": null,
    "plus_loan_has_endorser": false,
    "plus_loan_endorser_amount": null,
    "plus_loan_credit_requirements_met": false,
    "loan_booked_cod_response_id": null,
    "year_coa": null,
    "cod_id": null,
    "cod_amount": 2000,
    "cod_origination_fee_percent": null,
    "cod_start_date": null,
    "cod_end_date": null,
    "cod_student_level_code": null,
    "cod_academic_year_start_date": null,
    "cod_academic_year_end_date": null,
    "cod_program_length": null,
    "cod_program_length_units": null,
    "cod_program_credential_level": null,
    "enrollment_status_effective_date": null,
    "cod_special_program": null,
    "cod_weeks_programs_academic_year": null,
    "cod_program_cip_code": null,
    "cod_plus_application_id": null,
    "cod_borrower_id": null,
    "refunds_go_to": "student",
    "cod_most_recent_response_id": null,
    "cod_status": null,
    "cod_sync_logic": "automatic",
    "cod_syncable": false,
    "cod_syncable_errors": "[\"Award must be Accepted or Canceled in order to sync to COD.\",\"Student does not have a valid SSN (9 numeric digits).\",\"Your institution doesn't have an OPE ID entered in financial aid settings.\",\"No ISIR for this student for this aid year.\",\"No birth date for this student.\",\"No COD student eligibility code for this student (High School Diploma, etc).\",\"Dependency status must be set to Dependent or Independent on this student's aid application.\",\"No COD program length set for this student.\",\"No COD program credential level for this student.\",\"No CIP code.\"]",
    "cod_needs_sync": true,
    "cod_originated": false,
    "external_id": null,
    "esign_by_student_at": null,
    "esign_by_student_ip": null,
    "work_study_hours_per_week": null,
    "added_at": "2026-07-25T16:24:10+00:00",
    "added_by_id": 22,
    "sandbox": true
}

Creates a new AidAward object.

HTTP Request

POST /people/(person)/aidawards

Parameters

Name Required Data Type Description
aid_year_id Yes int
aid_type_id Yes int
status Yes enum (setup, offered, accepted, declined, canceled, deleted)
amount Yes decimal
net_amount Yes decimal
max_amount No decimal

Permissions

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

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)" \
-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)/aidawards/(aidaward)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body
import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)',
 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)/aidawards/(aidaward)"), 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)/aidawards/(aidaward)');
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_award",
    "id": 8,
    "student_id": 16,
    "aid_year_id": 1,
    "aid_type_id": 9,
    "sequence_number": 1,
    "original_accepted_amount": 4000,
    "award_limit": 4000,
    "max_amount": 4000,
    "net_amount": 4000,
    "multiplier": null,
    "auto_calc_percent_amount": false,
    "fee_percent": null,
    "status": "accepted",
    "loan_booked_on": null,
    "loan_payment_to_servicer_amount": 0,
    "loan_payment_to_servicer_date": null,
    "plus_loan_has_endorser": false,
    "plus_loan_endorser_amount": null,
    "plus_loan_credit_requirements_met": false,
    "loan_booked_cod_response_id": null,
    "year_coa": null,
    "cod_id": null,
    "cod_amount": 0,
    "cod_origination_fee_percent": null,
    "cod_start_date": null,
    "cod_end_date": null,
    "cod_student_level_code": null,
    "cod_academic_year_start_date": null,
    "cod_academic_year_end_date": null,
    "cod_program_length": null,
    "cod_program_length_units": null,
    "cod_program_credential_level": null,
    "enrollment_status_effective_date": null,
    "cod_special_program": null,
    "cod_weeks_programs_academic_year": null,
    "cod_program_cip_code": null,
    "cod_plus_application_id": null,
    "cod_borrower_id": null,
    "refunds_go_to": "student",
    "cod_most_recent_response_id": null,
    "cod_status": null,
    "cod_sync_logic": "automatic",
    "cod_syncable": true,
    "cod_syncable_errors": null,
    "cod_needs_sync": true,
    "cod_originated": false,
    "external_id": null,
    "esign_by_student_at": null,
    "esign_by_student_ip": null,
    "work_study_hours_per_week": null,
    "aid_year": {
        "object": "aid_year",
        "id": 1,
        "name": "2010-2011",
        "start_date": "2010-07-01",
        "end_date": "2011-06-30"
    },
    "aid_type": {
        "object": "aid_type",
        "id": 9,
        "startyear": 1,
        "endyear": null,
        "name": "Institutional Grant",
        "abbrv": "INST",
        "cod_abbrv": "NULL",
        "title_iv": false,
        "type": "grant",
        "is_scholarship": false,
        "source": "institution",
        "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
    },
    "aid_disbursements": [
        {
            "object": "aid_disbursement",
            "id": 15,
            "academic_term_id": 8,
            "student_id": 16,
            "aid_id": 9,
            "aid_award_id": 8,
            "type": "disbursement",
            "status": "scheduled",
            "amount": 440.7,
            "gross_amount": 440.7,
            "max_amount": 0,
            "multiplier": null,
            "scheduled_date": "2023-02-16",
            "posted_date": null,
            "status_date": "2023-02-16",
            "payment_id": null,
            "refund_id": null,
            "transaction_id": null,
            "disbursement_number": true,
            "sequence_number": false,
            "enrollment_status": null,
            "enrollment_intensity": false,
            "institutional_limit_applied": false,
            "enrollment_status_effective_date": null,
            "enrollment_verified": false,
            "enrollment_verified_by_id": null,
            "enrollment_verified_at": null,
            "cod_status": null,
            "cod_amount": 0,
            "cod_originated": false,
            "cod_net_amount": 0,
            "cod_released": false,
            "cod_needs_sync": true,
            "cod_program_cip_code": null,
            "cod_payment_period_start_date": null,
            "external_id": null,
            "email_message_id": null,
            "added_at": null,
            "added_by_id": null
        }
    ],
    "added_at": "2015-09-09T07:53:22+00:00",
    "added_by_id": 11,
    "sandbox": true
}

Retrieves a specific AidAward object.

HTTP Request

GET /people/(person)/aidawards/(aidaward)

Parameters

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

Permissions

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

update

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X PUT
require 'httparty'
response = HTTParty.put(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body
import requests
response = requests.put(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)',
 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)/aidawards/(aidaward)"), Method.Put);
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)/aidawards/(aidaward)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "aid_award",
    "id": 8,
    "student_id": 16,
    "aid_year_id": 1,
    "aid_type_id": 9,
    "sequence_number": 1,
    "original_accepted_amount": 0,
    "award_limit": 4000,
    "max_amount": 4000,
    "net_amount": 4000,
    "multiplier": null,
    "auto_calc_percent_amount": false,
    "fee_percent": null,
    "status": "accepted",
    "loan_booked_on": null,
    "loan_payment_to_servicer_amount": 0,
    "loan_payment_to_servicer_date": null,
    "plus_loan_has_endorser": false,
    "plus_loan_endorser_amount": null,
    "plus_loan_credit_requirements_met": false,
    "loan_booked_cod_response_id": null,
    "year_coa": null,
    "cod_id": null,
    "cod_amount": 0,
    "cod_origination_fee_percent": null,
    "cod_start_date": null,
    "cod_end_date": null,
    "cod_student_level_code": null,
    "cod_academic_year_start_date": null,
    "cod_academic_year_end_date": null,
    "cod_program_length": null,
    "cod_program_length_units": null,
    "cod_program_credential_level": null,
    "enrollment_status_effective_date": null,
    "cod_special_program": null,
    "cod_weeks_programs_academic_year": null,
    "cod_program_cip_code": null,
    "cod_plus_application_id": null,
    "cod_borrower_id": null,
    "refunds_go_to": "student",
    "cod_most_recent_response_id": null,
    "cod_status": null,
    "cod_sync_logic": "automatic",
    "cod_syncable": false,
    "cod_syncable_errors": "[\"Student does not have a valid SSN (9 numeric digits).\",\"No address found for this student.\",\"Your institution doesn't have an OPE ID entered in financial aid settings.\",\"No aid application for this student for this aid year.\",\"No birth date for this student.\",\"Dependency status must be set to Dependent or Independent on this student's aid application.\",\"No COD program length set for this student.\",\"No COD program credential level for this student.\",\"Feb 16, 2023 disbursement in \\\"Spring 2010 2009-2010\\\" has an invalid sequence number.\",\"No CIP code.\"]",
    "cod_needs_sync": true,
    "cod_originated": false,
    "external_id": null,
    "esign_by_student_at": null,
    "esign_by_student_ip": null,
    "work_study_hours_per_week": null,
    "added_at": "2015-09-09T07:53:22+00:00",
    "added_by_id": 11,
    "sandbox": true
}

Updates an existing AidAward object.

HTTP Request

PUT /people/(person)/aidawards/(aidaward)

Parameters

Name Required Data Type Description
status No enum (setup, offered, accepted, declined, canceled, deleted)
amount No decimal
net_amount No decimal
max_amount No decimal

Permissions

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

delete

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)" \
-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)/aidawards/(aidaward)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body
import requests
response = requests.delete(
 'https://yourschool.populiweb.com/api2/people/(person)/aidawards/(aidaward)',
 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)/aidawards/(aidaward)"), 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)/aidawards/(aidaward)');
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_award",
    "id": 9,
    "deleted": true
}

Deletes an existing AidAward object.

HTTP Request

DELETE /people/(person)/aidawards/(aidaward)

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: