| Required role: | REGISUserRole |
| POST | /Finance/FinancialAid/Applications |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidApplicationAwardResponse:
id: int = 0
award_code: Optional[str] = None
award_description: Optional[str] = None
is_awarded: bool = False
is_planned: bool = False
is_eligible: bool = False
award_amount: Optional[Decimal] = None
award_budget: Optional[Decimal] = None
comments: Optional[str] = None
term: Optional[str] = None
awarded_by: Optional[str] = None
awarded_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidApplicationResponse:
response_status: Optional[ResponseStatus] = None
start_term: Optional[str] = None
end_term: Optional[str] = None
number_of_terms: Optional[int] = None
regent_id: int = 0
uuid: Optional[str] = None
application_uuid: Optional[str] = None
awards: Optional[List[FinancialAidApplicationAwardResponse]] = None
previous_awards: Optional[List[FinancialAidApplicationAwardResponse]] = None
program: Optional[str] = None
gender: Optional[str] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
email: Optional[str] = None
citizenship: Optional[str] = None
citizenship_other: Optional[str] = None
permanent_resident: Optional[str] = None
ethnicity: Optional[str] = None
marital_status: Optional[str] = None
dob: Optional[datetime.datetime] = None
addr1: Optional[str] = None
addr2: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
country: Optional[str] = None
code: Optional[str] = None
denomination: Optional[str] = None
undergrad_gpa: Optional[Decimal] = None
regent_gpa: Optional[Decimal] = None
current_attempted_credits: Optional[Decimal] = None
first_term_admitted: Optional[str] = None
current_attempted_and_transferred_credits: Optional[Decimal] = None
current_award_term_attempted_credits: Optional[Decimal] = None
number_of_children: Optional[int] = None
financial_assets: Optional[Decimal] = None
spouse_income: Optional[Decimal] = None
employment_years: Optional[int] = None
employment_description: Optional[str] = None
vocational_experience_json: Optional[str] = None
vocational_direction_json: Optional[str] = None
occupation_after_the_program_json: Optional[str] = None
area_of_study_json: Optional[str] = None
need_score: int = 0
merit_score: int = 0
score: int = 0
is_mature: bool = False
is_nonaccredited: bool = False
award_per_term: Optional[Decimal] = None
amount_awarded: Optional[Decimal] = None
oncampus_tuition_owing_in_term: Optional[Decimal] = None
online_tuition_owing_in_term: Optional[Decimal] = None
audit_and_fees_owing_in_term: Optional[Decimal] = None
amount_offered: Optional[Decimal] = None
total_amount_awarded: Optional[Decimal] = None
comments: Optional[str] = None
current_status: Optional[str] = None
cannot_apply_again: bool = False
current_status_date: Optional[datetime.datetime] = None
started_date: Optional[datetime.datetime] = None
started_by: Optional[str] = None
submitted_date: Optional[datetime.datetime] = None
submitted_by: Optional[str] = None
changed_date: Optional[datetime.datetime] = None
changed_by: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidApplicationsResponse:
response_status: Optional[ResponseStatus] = None
applications: Optional[List[FinancialAidApplicationResponse]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidApplicationsRequest:
start_term: Optional[str] = None
continuing_term: Optional[str] = None
issued_in_term: Optional[str] = None
available_in_term: Optional[str] = None
done_in_term: Optional[str] = None
no_awards_in_response: bool = False
Python 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
}
]
}