| Required role: | REGISUserRole |
| POST | /Finance/FinancialAid/Applications |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses
Namespace Global
Namespace regis.ClassLibrary.Requests
Public Partial Class FinancialAidApplicationsRequest
Public Overridable Property start_term As String
Public Overridable Property continuing_term As String
Public Overridable Property issued_in_term As String
Public Overridable Property available_in_term As String
Public Overridable Property done_in_term As String
Public Overridable Property no_awards_in_response As Boolean
End Class
End Namespace
Namespace regis.ClassLibrary.Responses
Public Partial Class FinancialAidApplicationAwardResponse
Public Overridable Property id As Integer
Public Overridable Property award_code As String
Public Overridable Property award_description As String
Public Overridable Property is_awarded As Boolean
Public Overridable Property is_planned As Boolean
Public Overridable Property is_eligible As Boolean
Public Overridable Property award_amount As Nullable(Of Decimal)
Public Overridable Property award_budget As Nullable(Of Decimal)
Public Overridable Property comments As String
Public Overridable Property term As String
Public Overridable Property awarded_by As String
Public Overridable Property awarded_date As Nullable(Of Date)
End Class
Public Partial Class FinancialAidApplicationResponse
Public Sub New()
awards = New List(Of FinancialAidApplicationAwardResponse)
previous_awards = New List(Of FinancialAidApplicationAwardResponse)
End Sub
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property start_term As String
Public Overridable Property end_term As String
Public Overridable Property number_of_terms As Nullable(Of Integer)
Public Overridable Property regent_id As Integer
Public Overridable Property uuid As String
Public Overridable Property application_uuid As String
Public Overridable Property awards As List(Of FinancialAidApplicationAwardResponse)
Public Overridable Property previous_awards As List(Of FinancialAidApplicationAwardResponse)
Public Overridable Property program As String
Public Overridable Property gender As String
Public Overridable Property first_name As String
Public Overridable Property last_name As String
Public Overridable Property email As String
Public Overridable Property citizenship As String
Public Overridable Property citizenship_other As String
Public Overridable Property permanent_resident As String
Public Overridable Property ethnicity As String
Public Overridable Property marital_status As String
Public Overridable Property dob As Nullable(Of Date)
Public Overridable Property addr1 As String
Public Overridable Property addr2 As String
Public Overridable Property city As String
Public Overridable Property state As String
Public Overridable Property country As String
Public Overridable Property code As String
Public Overridable Property denomination As String
Public Overridable Property undergrad_gpa As Nullable(Of Decimal)
Public Overridable Property regent_gpa As Nullable(Of Decimal)
Public Overridable Property current_attempted_credits As Nullable(Of Decimal)
Public Overridable Property first_term_admitted As String
Public Overridable Property current_attempted_and_transferred_credits As Nullable(Of Decimal)
Public Overridable Property current_award_term_attempted_credits As Nullable(Of Decimal)
Public Overridable Property number_of_children As Nullable(Of Integer)
Public Overridable Property financial_assets As Nullable(Of Decimal)
Public Overridable Property spouse_income As Nullable(Of Decimal)
Public Overridable Property employment_years As Nullable(Of Integer)
Public Overridable Property employment_description As String
Public Overridable Property vocational_experience_json As String
Public Overridable Property vocational_direction_json As String
Public Overridable Property occupation_after_the_program_json As String
Public Overridable Property area_of_study_json As String
Public Overridable Property need_score As Integer
Public Overridable Property merit_score As Integer
Public Overridable Property score As Integer
Public Overridable Property is_mature As Boolean
Public Overridable Property is_nonaccredited As Boolean
Public Overridable Property award_per_term As Nullable(Of Decimal)
Public Overridable Property amount_awarded As Nullable(Of Decimal)
Public Overridable Property oncampus_tuition_owing_in_term As Nullable(Of Decimal)
Public Overridable Property online_tuition_owing_in_term As Nullable(Of Decimal)
Public Overridable Property audit_and_fees_owing_in_term As Nullable(Of Decimal)
Public Overridable Property amount_offered As Nullable(Of Decimal)
Public Overridable Property total_amount_awarded As Nullable(Of Decimal)
Public Overridable Property comments As String
Public Overridable Property current_status As String
Public Overridable Property cannot_apply_again As Boolean
Public Overridable Property current_status_date As Nullable(Of Date)
Public Overridable Property started_date As Nullable(Of Date)
Public Overridable Property started_by As String
Public Overridable Property submitted_date As Nullable(Of Date)
Public Overridable Property submitted_by As String
Public Overridable Property changed_date As Nullable(Of Date)
Public Overridable Property changed_by As String
End Class
Public Partial Class FinancialAidApplicationsResponse
Public Sub New()
applications = New List(Of FinancialAidApplicationResponse)
End Sub
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property applications As List(Of FinancialAidApplicationResponse)
End Class
End Namespace
End Namespace
VB.NET 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
}
]
}