| Required permission: | FinancialAidPermission |
| POST | /Finance/FinancialAid/{uuid}/Summary |
|---|
"use strict";
export class FinancialAidApplicationAwardResponse {
/** @param {{id?:number,award_code?:string,award_description?:string,is_awarded?:boolean,is_planned?:boolean,is_eligible?:boolean,award_amount?:number,award_budget?:number,comments?:string,term?:string,awarded_by?:string,awarded_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
award_code;
/** @type {string} */
award_description;
/** @type {boolean} */
is_awarded;
/** @type {boolean} */
is_planned;
/** @type {boolean} */
is_eligible;
/** @type {?number} */
award_amount;
/** @type {?number} */
award_budget;
/** @type {string} */
comments;
/** @type {string} */
term;
/** @type {string} */
awarded_by;
/** @type {?string} */
awarded_date;
}
export class FinancialAidApplicationResponse {
/** @param {{responseStatus?:ResponseStatus,start_term?:string,end_term?:string,number_of_terms?:number,regent_id?:number,uuid?:string,application_uuid?:string,awards?:FinancialAidApplicationAwardResponse[],previous_awards?:FinancialAidApplicationAwardResponse[],program?:string,gender?:string,first_name?:string,last_name?:string,email?:string,citizenship?:string,citizenship_other?:string,permanent_resident?:string,ethnicity?:string,marital_status?:string,dob?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,denomination?:string,undergrad_gpa?:number,regent_gpa?:number,current_attempted_credits?:number,first_term_admitted?:string,current_attempted_and_transferred_credits?:number,current_award_term_attempted_credits?:number,number_of_children?:number,financial_assets?:number,spouse_income?:number,employment_years?:number,employment_description?:string,vocational_experience_json?:string,vocational_direction_json?:string,occupation_after_the_program_json?:string,area_of_study_json?:string,need_score?:number,merit_score?:number,score?:number,is_mature?:boolean,is_nonaccredited?:boolean,award_per_term?:number,amount_awarded?:number,oncampus_tuition_owing_in_term?:number,online_tuition_owing_in_term?:number,audit_and_fees_owing_in_term?:number,amount_offered?:number,total_amount_awarded?:number,comments?:string,current_status?:string,cannot_apply_again?:boolean,current_status_date?:string,started_date?:string,started_by?:string,submitted_date?:string,submitted_by?:string,changed_date?:string,changed_by?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
start_term;
/** @type {string} */
end_term;
/** @type {?number} */
number_of_terms;
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {string} */
application_uuid;
/** @type {FinancialAidApplicationAwardResponse[]} */
awards;
/** @type {FinancialAidApplicationAwardResponse[]} */
previous_awards;
/** @type {string} */
program;
/** @type {string} */
gender;
/** @type {string} */
first_name;
/** @type {string} */
last_name;
/** @type {string} */
email;
/** @type {string} */
citizenship;
/** @type {string} */
citizenship_other;
/** @type {string} */
permanent_resident;
/** @type {string} */
ethnicity;
/** @type {string} */
marital_status;
/** @type {?string} */
dob;
/** @type {string} */
addr1;
/** @type {string} */
addr2;
/** @type {string} */
city;
/** @type {string} */
state;
/** @type {string} */
country;
/** @type {string} */
code;
/** @type {string} */
denomination;
/** @type {?number} */
undergrad_gpa;
/** @type {?number} */
regent_gpa;
/** @type {?number} */
current_attempted_credits;
/** @type {string} */
first_term_admitted;
/** @type {?number} */
current_attempted_and_transferred_credits;
/** @type {?number} */
current_award_term_attempted_credits;
/** @type {?number} */
number_of_children;
/** @type {?number} */
financial_assets;
/** @type {?number} */
spouse_income;
/** @type {?number} */
employment_years;
/** @type {string} */
employment_description;
/** @type {string} */
vocational_experience_json;
/** @type {string} */
vocational_direction_json;
/** @type {string} */
occupation_after_the_program_json;
/** @type {string} */
area_of_study_json;
/** @type {number} */
need_score;
/** @type {number} */
merit_score;
/** @type {number} */
score;
/** @type {boolean} */
is_mature;
/** @type {boolean} */
is_nonaccredited;
/** @type {?number} */
award_per_term;
/** @type {?number} */
amount_awarded;
/** @type {?number} */
oncampus_tuition_owing_in_term;
/** @type {?number} */
online_tuition_owing_in_term;
/** @type {?number} */
audit_and_fees_owing_in_term;
/** @type {?number} */
amount_offered;
/** @type {?number} */
total_amount_awarded;
/** @type {string} */
comments;
/** @type {string} */
current_status;
/** @type {boolean} */
cannot_apply_again;
/** @type {?string} */
current_status_date;
/** @type {?string} */
started_date;
/** @type {string} */
started_by;
/** @type {?string} */
submitted_date;
/** @type {string} */
submitted_by;
/** @type {?string} */
changed_date;
/** @type {string} */
changed_by;
}
export class FinancialAidSummaryResponse {
/** @param {{responseStatus?:ResponseStatus,uuid?:string,applications?:FinancialAidApplicationResponse[],awards?:FinancialAidApplicationAwardResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
uuid;
/** @type {FinancialAidApplicationResponse[]} */
applications;
/** @type {FinancialAidApplicationAwardResponse[]} */
awards;
}
export class FinancialAidSummaryRequest {
/** @param {{uuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
}
JavaScript FinancialAidSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Finance/FinancialAid/{uuid}/Summary HTTP/1.1
Host: data.regent-college.edu
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","applications":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"start_term":"String","end_term":"String","number_of_terms":0,"regent_id":0,"uuid":"String","application_uuid":"String","awards":[{"id":0,"award_code":"String","award_description":"String","is_awarded":false,"is_planned":false,"is_eligible":false,"award_amount":0,"award_budget":0,"comments":"String","term":"String","awarded_by":"String","awarded_date":"0001-01-01T00:00:00.0000000"}],"previous_awards":[{"id":0,"award_code":"String","award_description":"String","is_awarded":false,"is_planned":false,"is_eligible":false,"award_amount":0,"award_budget":0,"comments":"String","term":"String","awarded_by":"String","awarded_date":"0001-01-01T00:00:00.0000000"}],"program":"String","gender":"String","first_name":"String","last_name":"String","email":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","ethnicity":"String","marital_status":"String","dob":"0001-01-01T00:00:00.0000000","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","denomination":"String","undergrad_gpa":0,"regent_gpa":0,"current_attempted_credits":0,"first_term_admitted":"String","current_attempted_and_transferred_credits":0,"current_award_term_attempted_credits":0,"number_of_children":0,"financial_assets":0,"spouse_income":0,"employment_years":0,"employment_description":"String","vocational_experience_json":"String","vocational_direction_json":"String","occupation_after_the_program_json":"String","area_of_study_json":"String","need_score":0,"merit_score":0,"score":0,"is_mature":false,"is_nonaccredited":false,"award_per_term":0,"amount_awarded":0,"oncampus_tuition_owing_in_term":0,"online_tuition_owing_in_term":0,"audit_and_fees_owing_in_term":0,"amount_offered":0,"total_amount_awarded":0,"comments":"String","current_status":"String","cannot_apply_again":false,"current_status_date":"0001-01-01T00:00:00.0000000","started_date":"0001-01-01T00:00:00.0000000","started_by":"String","submitted_date":"0001-01-01T00:00:00.0000000","submitted_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String"}],"awards":[{"id":0,"award_code":"String","award_description":"String","is_awarded":false,"is_planned":false,"is_eligible":false,"award_amount":0,"award_budget":0,"comments":"String","term":"String","awarded_by":"String","awarded_date":"0001-01-01T00:00:00.0000000"}]}