| Required role: | REGISUserRole |
| POST | /Finance/FinancialAid/Applications |
|---|
import Foundation
import ServiceStack
public class FinancialAidApplicationsRequest : Codable
{
public var start_term:String
public var continuing_term:String
public var issued_in_term:String
public var available_in_term:String
public var done_in_term:String
public var no_awards_in_response:Bool
required public init(){}
}
public class FinancialAidApplicationsResponse : Codable
{
public var responseStatus:ResponseStatus
public var applications:[FinancialAidApplicationResponse] = []
required public init(){}
}
public class FinancialAidApplicationResponse : Codable
{
public var responseStatus:ResponseStatus
public var start_term:String
public var end_term:String
public var number_of_terms:Int?
public var regent_id:Int
public var uuid:String
public var application_uuid:String
public var awards:[FinancialAidApplicationAwardResponse] = []
public var previous_awards:[FinancialAidApplicationAwardResponse] = []
public var program:String
public var gender:String
public var first_name:String
public var last_name:String
public var email:String
public var citizenship:String
public var citizenship_other:String
public var permanent_resident:String
public var ethnicity:String
public var marital_status:String
public var dob:Date?
public var addr1:String
public var addr2:String
public var city:String
public var state:String
public var country:String
public var code:String
public var denomination:String
public var undergrad_gpa:Double?
public var regent_gpa:Double?
public var current_attempted_credits:Double?
public var first_term_admitted:String
public var current_attempted_and_transferred_credits:Double?
public var current_award_term_attempted_credits:Double?
public var number_of_children:Int?
public var financial_assets:Double?
public var spouse_income:Double?
public var employment_years:Int?
public var employment_description:String
public var vocational_experience_json:String
public var vocational_direction_json:String
public var occupation_after_the_program_json:String
public var area_of_study_json:String
public var need_score:Int
public var merit_score:Int
public var score:Int
public var is_mature:Bool
public var is_nonaccredited:Bool
public var award_per_term:Double?
public var amount_awarded:Double?
public var oncampus_tuition_owing_in_term:Double?
public var online_tuition_owing_in_term:Double?
public var audit_and_fees_owing_in_term:Double?
public var amount_offered:Double?
public var total_amount_awarded:Double?
public var comments:String
public var current_status:String
public var cannot_apply_again:Bool
public var current_status_date:Date?
public var started_date:Date?
public var started_by:String
public var submitted_date:Date?
public var submitted_by:String
public var changed_date:Date?
public var changed_by:String
required public init(){}
}
public class FinancialAidApplicationAwardResponse : Codable
{
public var id:Int
public var award_code:String
public var award_description:String
public var is_awarded:Bool
public var is_planned:Bool
public var is_eligible:Bool
public var award_amount:Double?
public var award_budget:Double?
public var comments:String
public var term:String
public var awarded_by:String
public var awarded_date:Date?
required public init(){}
}
Swift FinancialAidApplicationsRequest 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/Applications HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
start_term: String,
continuing_term: String,
issued_in_term: String,
available_in_term: String,
done_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
}
},
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
}
]
}