| Required role: | REGISUserRole |
| POST | /Finance/FinancialAid/Applications |
|---|
"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 FinancialAidApplicationsResponse {
/** @param {{responseStatus?:ResponseStatus,applications?:FinancialAidApplicationResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {FinancialAidApplicationResponse[]} */
applications;
}
export class FinancialAidApplicationsRequest {
/** @param {{start_term?:string,continuing_term?:string,issued_in_term?:string,available_in_term?:string,done_in_term?:string,no_awards_in_response?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
start_term;
/** @type {string} */
continuing_term;
/** @type {string} */
issued_in_term;
/** @type {string} */
available_in_term;
/** @type {string} */
done_in_term;
/** @type {boolean} */
no_awards_in_response;
}
JavaScript FinancialAidApplicationsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Finance/FinancialAid/Applications HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FinancialAidApplicationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<available_in_term>String</available_in_term>
<continuing_term>String</continuing_term>
<done_in_term>String</done_in_term>
<issued_in_term>String</issued_in_term>
<no_awards_in_response>false</no_awards_in_response>
<start_term>String</start_term>
</FinancialAidApplicationsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FinancialAidApplicationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<applications>
<FinancialAidApplicationResponse>
<ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:Message>String</d4p1:Message>
<d4p1:StackTrace>String</d4p1:StackTrace>
<d4p1:Errors>
<d4p1:ResponseError>
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:FieldName>String</d4p1:FieldName>
<d4p1:Message>String</d4p1:Message>
<d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</d4p1:Meta>
</d4p1:ResponseError>
</d4p1:Errors>
<d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d4p1:Meta>
</ResponseStatus>
<addr1>String</addr1>
<addr2>String</addr2>
<amount_awarded>0</amount_awarded>
<amount_offered>0</amount_offered>
<application_uuid>String</application_uuid>
<area_of_study_json>String</area_of_study_json>
<audit_and_fees_owing_in_term>0</audit_and_fees_owing_in_term>
<award_per_term>0</award_per_term>
<awards>
<FinancialAidApplicationAwardResponse>
<award_amount>0</award_amount>
<award_budget>0</award_budget>
<award_code>String</award_code>
<award_description>String</award_description>
<awarded_by>String</awarded_by>
<awarded_date>0001-01-01T00:00:00</awarded_date>
<comments>String</comments>
<id>0</id>
<is_awarded>false</is_awarded>
<is_eligible>false</is_eligible>
<is_planned>false</is_planned>
<term>String</term>
</FinancialAidApplicationAwardResponse>
</awards>
<cannot_apply_again>false</cannot_apply_again>
<changed_by>String</changed_by>
<changed_date>0001-01-01T00:00:00</changed_date>
<citizenship>String</citizenship>
<citizenship_other>String</citizenship_other>
<city>String</city>
<code>String</code>
<comments>String</comments>
<country>String</country>
<current_attempted_and_transferred_credits>0</current_attempted_and_transferred_credits>
<current_attempted_credits>0</current_attempted_credits>
<current_award_term_attempted_credits>0</current_award_term_attempted_credits>
<current_status>String</current_status>
<current_status_date>0001-01-01T00:00:00</current_status_date>
<denomination>String</denomination>
<dob>0001-01-01T00:00:00</dob>
<email>String</email>
<employment_description>String</employment_description>
<employment_years>0</employment_years>
<end_term>String</end_term>
<ethnicity>String</ethnicity>
<financial_assets>0</financial_assets>
<first_name>String</first_name>
<first_term_admitted>String</first_term_admitted>
<gender>String</gender>
<is_mature>false</is_mature>
<is_nonaccredited>false</is_nonaccredited>
<last_name>String</last_name>
<marital_status>String</marital_status>
<merit_score>0</merit_score>
<need_score>0</need_score>
<number_of_children>0</number_of_children>
<number_of_terms>0</number_of_terms>
<occupation_after_the_program_json>String</occupation_after_the_program_json>
<oncampus_tuition_owing_in_term>0</oncampus_tuition_owing_in_term>
<online_tuition_owing_in_term>0</online_tuition_owing_in_term>
<permanent_resident>String</permanent_resident>
<previous_awards>
<FinancialAidApplicationAwardResponse>
<award_amount>0</award_amount>
<award_budget>0</award_budget>
<award_code>String</award_code>
<award_description>String</award_description>
<awarded_by>String</awarded_by>
<awarded_date>0001-01-01T00:00:00</awarded_date>
<comments>String</comments>
<id>0</id>
<is_awarded>false</is_awarded>
<is_eligible>false</is_eligible>
<is_planned>false</is_planned>
<term>String</term>
</FinancialAidApplicationAwardResponse>
</previous_awards>
<program>String</program>
<regent_gpa>0</regent_gpa>
<regent_id>0</regent_id>
<score>0</score>
<spouse_income>0</spouse_income>
<start_term>String</start_term>
<started_by>String</started_by>
<started_date>0001-01-01T00:00:00</started_date>
<state>String</state>
<submitted_by>String</submitted_by>
<submitted_date>0001-01-01T00:00:00</submitted_date>
<total_amount_awarded>0</total_amount_awarded>
<undergrad_gpa>0</undergrad_gpa>
<uuid>String</uuid>
<vocational_direction_json>String</vocational_direction_json>
<vocational_experience_json>String</vocational_experience_json>
</FinancialAidApplicationResponse>
</applications>
</FinancialAidApplicationsResponse>