| Required permission: | FinancialAidPermission |
| POST | /Finance/FinancialAid/Application/{application_uuid}/Get | ||
|---|---|---|---|
| POST | /Finance/FinancialAid/{uuid}/Application/{start_term} |
import 'package:servicestack/servicestack.dart';
class FinancialAidApplicationAwardResponse implements IConvertible
{
int? id;
String? award_code;
String? award_description;
bool? is_awarded;
bool? is_planned;
bool? is_eligible;
double? award_amount;
double? award_budget;
String? comments;
String? term;
String? awarded_by;
DateTime? awarded_date;
FinancialAidApplicationAwardResponse({this.id,this.award_code,this.award_description,this.is_awarded,this.is_planned,this.is_eligible,this.award_amount,this.award_budget,this.comments,this.term,this.awarded_by,this.awarded_date});
FinancialAidApplicationAwardResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
award_code = json['award_code'];
award_description = json['award_description'];
is_awarded = json['is_awarded'];
is_planned = json['is_planned'];
is_eligible = json['is_eligible'];
award_amount = JsonConverters.toDouble(json['award_amount']);
award_budget = JsonConverters.toDouble(json['award_budget']);
comments = json['comments'];
term = json['term'];
awarded_by = json['awarded_by'];
awarded_date = JsonConverters.fromJson(json['awarded_date'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'award_code': award_code,
'award_description': award_description,
'is_awarded': is_awarded,
'is_planned': is_planned,
'is_eligible': is_eligible,
'award_amount': award_amount,
'award_budget': award_budget,
'comments': comments,
'term': term,
'awarded_by': awarded_by,
'awarded_date': JsonConverters.toJson(awarded_date,'DateTime',context!)
};
getTypeName() => "FinancialAidApplicationAwardResponse";
TypeContext? context = _ctx;
}
class FinancialAidApplicationResponse implements IConvertible
{
ResponseStatus? responseStatus;
String? start_term;
String? end_term;
int? number_of_terms;
int? regent_id;
String? uuid;
String? application_uuid;
List<FinancialAidApplicationAwardResponse>? awards;
List<FinancialAidApplicationAwardResponse>? previous_awards;
String? program;
String? gender;
String? first_name;
String? last_name;
String? email;
String? citizenship;
String? citizenship_other;
String? permanent_resident;
String? ethnicity;
String? marital_status;
DateTime? dob;
String? addr1;
String? addr2;
String? city;
String? state;
String? country;
String? code;
String? denomination;
double? undergrad_gpa;
double? regent_gpa;
double? current_attempted_credits;
String? first_term_admitted;
double? current_attempted_and_transferred_credits;
double? current_award_term_attempted_credits;
int? number_of_children;
double? financial_assets;
double? spouse_income;
int? employment_years;
String? employment_description;
String? vocational_experience_json;
String? vocational_direction_json;
String? occupation_after_the_program_json;
String? area_of_study_json;
int? need_score;
int? merit_score;
int? score;
bool? is_mature;
bool? is_nonaccredited;
double? award_per_term;
double? amount_awarded;
double? oncampus_tuition_owing_in_term;
double? online_tuition_owing_in_term;
double? audit_and_fees_owing_in_term;
double? amount_offered;
double? total_amount_awarded;
String? comments;
String? current_status;
bool? cannot_apply_again;
DateTime? current_status_date;
DateTime? started_date;
String? started_by;
DateTime? submitted_date;
String? submitted_by;
DateTime? changed_date;
String? changed_by;
FinancialAidApplicationResponse({this.responseStatus,this.start_term,this.end_term,this.number_of_terms,this.regent_id,this.uuid,this.application_uuid,this.awards,this.previous_awards,this.program,this.gender,this.first_name,this.last_name,this.email,this.citizenship,this.citizenship_other,this.permanent_resident,this.ethnicity,this.marital_status,this.dob,this.addr1,this.addr2,this.city,this.state,this.country,this.code,this.denomination,this.undergrad_gpa,this.regent_gpa,this.current_attempted_credits,this.first_term_admitted,this.current_attempted_and_transferred_credits,this.current_award_term_attempted_credits,this.number_of_children,this.financial_assets,this.spouse_income,this.employment_years,this.employment_description,this.vocational_experience_json,this.vocational_direction_json,this.occupation_after_the_program_json,this.area_of_study_json,this.need_score,this.merit_score,this.score,this.is_mature,this.is_nonaccredited,this.award_per_term,this.amount_awarded,this.oncampus_tuition_owing_in_term,this.online_tuition_owing_in_term,this.audit_and_fees_owing_in_term,this.amount_offered,this.total_amount_awarded,this.comments,this.current_status,this.cannot_apply_again,this.current_status_date,this.started_date,this.started_by,this.submitted_date,this.submitted_by,this.changed_date,this.changed_by});
FinancialAidApplicationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
start_term = json['start_term'];
end_term = json['end_term'];
number_of_terms = json['number_of_terms'];
regent_id = json['regent_id'];
uuid = json['uuid'];
application_uuid = json['application_uuid'];
awards = JsonConverters.fromJson(json['awards'],'List<FinancialAidApplicationAwardResponse>',context!);
previous_awards = JsonConverters.fromJson(json['previous_awards'],'List<FinancialAidApplicationAwardResponse>',context!);
program = json['program'];
gender = json['gender'];
first_name = json['first_name'];
last_name = json['last_name'];
email = json['email'];
citizenship = json['citizenship'];
citizenship_other = json['citizenship_other'];
permanent_resident = json['permanent_resident'];
ethnicity = json['ethnicity'];
marital_status = json['marital_status'];
dob = JsonConverters.fromJson(json['dob'],'DateTime',context!);
addr1 = json['addr1'];
addr2 = json['addr2'];
city = json['city'];
state = json['state'];
country = json['country'];
code = json['code'];
denomination = json['denomination'];
undergrad_gpa = JsonConverters.toDouble(json['undergrad_gpa']);
regent_gpa = JsonConverters.toDouble(json['regent_gpa']);
current_attempted_credits = JsonConverters.toDouble(json['current_attempted_credits']);
first_term_admitted = json['first_term_admitted'];
current_attempted_and_transferred_credits = JsonConverters.toDouble(json['current_attempted_and_transferred_credits']);
current_award_term_attempted_credits = JsonConverters.toDouble(json['current_award_term_attempted_credits']);
number_of_children = json['number_of_children'];
financial_assets = JsonConverters.toDouble(json['financial_assets']);
spouse_income = JsonConverters.toDouble(json['spouse_income']);
employment_years = json['employment_years'];
employment_description = json['employment_description'];
vocational_experience_json = json['vocational_experience_json'];
vocational_direction_json = json['vocational_direction_json'];
occupation_after_the_program_json = json['occupation_after_the_program_json'];
area_of_study_json = json['area_of_study_json'];
need_score = json['need_score'];
merit_score = json['merit_score'];
score = json['score'];
is_mature = json['is_mature'];
is_nonaccredited = json['is_nonaccredited'];
award_per_term = JsonConverters.toDouble(json['award_per_term']);
amount_awarded = JsonConverters.toDouble(json['amount_awarded']);
oncampus_tuition_owing_in_term = JsonConverters.toDouble(json['oncampus_tuition_owing_in_term']);
online_tuition_owing_in_term = JsonConverters.toDouble(json['online_tuition_owing_in_term']);
audit_and_fees_owing_in_term = JsonConverters.toDouble(json['audit_and_fees_owing_in_term']);
amount_offered = JsonConverters.toDouble(json['amount_offered']);
total_amount_awarded = JsonConverters.toDouble(json['total_amount_awarded']);
comments = json['comments'];
current_status = json['current_status'];
cannot_apply_again = json['cannot_apply_again'];
current_status_date = JsonConverters.fromJson(json['current_status_date'],'DateTime',context!);
started_date = JsonConverters.fromJson(json['started_date'],'DateTime',context!);
started_by = json['started_by'];
submitted_date = JsonConverters.fromJson(json['submitted_date'],'DateTime',context!);
submitted_by = json['submitted_by'];
changed_date = JsonConverters.fromJson(json['changed_date'],'DateTime',context!);
changed_by = json['changed_by'];
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'start_term': start_term,
'end_term': end_term,
'number_of_terms': number_of_terms,
'regent_id': regent_id,
'uuid': uuid,
'application_uuid': application_uuid,
'awards': JsonConverters.toJson(awards,'List<FinancialAidApplicationAwardResponse>',context!),
'previous_awards': JsonConverters.toJson(previous_awards,'List<FinancialAidApplicationAwardResponse>',context!),
'program': program,
'gender': gender,
'first_name': first_name,
'last_name': last_name,
'email': email,
'citizenship': citizenship,
'citizenship_other': citizenship_other,
'permanent_resident': permanent_resident,
'ethnicity': ethnicity,
'marital_status': marital_status,
'dob': JsonConverters.toJson(dob,'DateTime',context!),
'addr1': addr1,
'addr2': addr2,
'city': city,
'state': state,
'country': country,
'code': code,
'denomination': denomination,
'undergrad_gpa': undergrad_gpa,
'regent_gpa': regent_gpa,
'current_attempted_credits': current_attempted_credits,
'first_term_admitted': first_term_admitted,
'current_attempted_and_transferred_credits': current_attempted_and_transferred_credits,
'current_award_term_attempted_credits': current_award_term_attempted_credits,
'number_of_children': number_of_children,
'financial_assets': financial_assets,
'spouse_income': spouse_income,
'employment_years': employment_years,
'employment_description': employment_description,
'vocational_experience_json': vocational_experience_json,
'vocational_direction_json': vocational_direction_json,
'occupation_after_the_program_json': occupation_after_the_program_json,
'area_of_study_json': area_of_study_json,
'need_score': need_score,
'merit_score': merit_score,
'score': score,
'is_mature': is_mature,
'is_nonaccredited': is_nonaccredited,
'award_per_term': award_per_term,
'amount_awarded': amount_awarded,
'oncampus_tuition_owing_in_term': oncampus_tuition_owing_in_term,
'online_tuition_owing_in_term': online_tuition_owing_in_term,
'audit_and_fees_owing_in_term': audit_and_fees_owing_in_term,
'amount_offered': amount_offered,
'total_amount_awarded': total_amount_awarded,
'comments': comments,
'current_status': current_status,
'cannot_apply_again': cannot_apply_again,
'current_status_date': JsonConverters.toJson(current_status_date,'DateTime',context!),
'started_date': JsonConverters.toJson(started_date,'DateTime',context!),
'started_by': started_by,
'submitted_date': JsonConverters.toJson(submitted_date,'DateTime',context!),
'submitted_by': submitted_by,
'changed_date': JsonConverters.toJson(changed_date,'DateTime',context!),
'changed_by': changed_by
};
getTypeName() => "FinancialAidApplicationResponse";
TypeContext? context = _ctx;
}
class FinancialAidApplicationRequest implements IConvertible
{
String? uuid;
String? start_term;
String? application_uuid;
String? awards_in_term;
bool? no_awards_in_response;
FinancialAidApplicationRequest({this.uuid,this.start_term,this.application_uuid,this.awards_in_term,this.no_awards_in_response});
FinancialAidApplicationRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
uuid = json['uuid'];
start_term = json['start_term'];
application_uuid = json['application_uuid'];
awards_in_term = json['awards_in_term'];
no_awards_in_response = json['no_awards_in_response'];
return this;
}
Map<String, dynamic> toJson() => {
'uuid': uuid,
'start_term': start_term,
'application_uuid': application_uuid,
'awards_in_term': awards_in_term,
'no_awards_in_response': no_awards_in_response
};
getTypeName() => "FinancialAidApplicationRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
'FinancialAidApplicationAwardResponse': TypeInfo(TypeOf.Class, create:() => FinancialAidApplicationAwardResponse()),
'FinancialAidApplicationResponse': TypeInfo(TypeOf.Class, create:() => FinancialAidApplicationResponse()),
'List<FinancialAidApplicationAwardResponse>': TypeInfo(TypeOf.Class, create:() => <FinancialAidApplicationAwardResponse>[]),
'FinancialAidApplicationRequest': TypeInfo(TypeOf.Class, create:() => FinancialAidApplicationRequest()),
});
Dart FinancialAidApplicationRequest 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/Application/{application_uuid}/Get HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String,
start_term: String,
application_uuid: String,
awards_in_term: String,
no_awards_in_response: False
}
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
}
},
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
}