| Required permission: | FinancialAidPermission |
| POST | /Finance/FinancialAid/{uuid}/Summary |
|---|
export class FinancialAidApplicationAwardResponse
{
public id: number;
public award_code: string;
public award_description: string;
public is_awarded: boolean;
public is_planned: boolean;
public is_eligible: boolean;
public award_amount?: number;
public award_budget?: number;
public comments: string;
public term: string;
public awarded_by: string;
public awarded_date?: string;
public constructor(init?: Partial<FinancialAidApplicationAwardResponse>) { (Object as any).assign(this, init); }
}
export class FinancialAidApplicationResponse
{
public responseStatus: ResponseStatus;
public start_term: string;
public end_term: string;
public number_of_terms?: number;
public regent_id: number;
public uuid: string;
public application_uuid: string;
public awards: FinancialAidApplicationAwardResponse[];
public previous_awards: FinancialAidApplicationAwardResponse[];
public program: string;
public gender: string;
public first_name: string;
public last_name: string;
public email: string;
public citizenship: string;
public citizenship_other: string;
public permanent_resident: string;
public ethnicity: string;
public marital_status: string;
public dob?: string;
public addr1: string;
public addr2: string;
public city: string;
public state: string;
public country: string;
public code: string;
public denomination: string;
public undergrad_gpa?: number;
public regent_gpa?: number;
public current_attempted_credits?: number;
public first_term_admitted: string;
public current_attempted_and_transferred_credits?: number;
public current_award_term_attempted_credits?: number;
public number_of_children?: number;
public financial_assets?: number;
public spouse_income?: number;
public employment_years?: number;
public employment_description: string;
public vocational_experience_json: string;
public vocational_direction_json: string;
public occupation_after_the_program_json: string;
public area_of_study_json: string;
public need_score: number;
public merit_score: number;
public score: number;
public is_mature: boolean;
public is_nonaccredited: boolean;
public award_per_term?: number;
public amount_awarded?: number;
public oncampus_tuition_owing_in_term?: number;
public online_tuition_owing_in_term?: number;
public audit_and_fees_owing_in_term?: number;
public amount_offered?: number;
public total_amount_awarded?: number;
public comments: string;
public current_status: string;
public cannot_apply_again: boolean;
public current_status_date?: string;
public started_date?: string;
public started_by: string;
public submitted_date?: string;
public submitted_by: string;
public changed_date?: string;
public changed_by: string;
public constructor(init?: Partial<FinancialAidApplicationResponse>) { (Object as any).assign(this, init); }
}
export class FinancialAidSummaryResponse
{
public responseStatus: ResponseStatus;
public uuid: string;
public applications: FinancialAidApplicationResponse[];
public awards: FinancialAidApplicationAwardResponse[];
public constructor(init?: Partial<FinancialAidSummaryResponse>) { (Object as any).assign(this, init); }
}
export class FinancialAidSummaryRequest
{
public uuid: string;
public constructor(init?: Partial<FinancialAidSummaryRequest>) { (Object as any).assign(this, init); }
}
TypeScript FinancialAidSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01
}
],
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-01
}
],
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-01,
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-01,
started_date: 0001-01-01,
started_by: String,
submitted_date: 0001-01-01,
submitted_by: String,
changed_date: 0001-01-01,
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-01
}
]
}