| Required permission: | FinancialAidPermission |
| POST | /Finance/FinancialAid/Application/{application_uuid}/Get | ||
|---|---|---|---|
| POST | /Finance/FinancialAid/{uuid}/Application/{start_term} |
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class FinancialAidApplicationAwardResponse implements JsonSerializable
{
public function __construct(
/** @var int */
public int $id=0,
/** @var string|null */
public ?string $award_code=null,
/** @var string|null */
public ?string $award_description=null,
/** @var bool|null */
public ?bool $is_awarded=null,
/** @var bool|null */
public ?bool $is_planned=null,
/** @var bool|null */
public ?bool $is_eligible=null,
/** @var float|null */
public ?float $award_amount=null,
/** @var float|null */
public ?float $award_budget=null,
/** @var string|null */
public ?string $comments=null,
/** @var string|null */
public ?string $term=null,
/** @var string|null */
public ?string $awarded_by=null,
/** @var DateTime|null */
public ?DateTime $awarded_date=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['award_code'])) $this->award_code = $o['award_code'];
if (isset($o['award_description'])) $this->award_description = $o['award_description'];
if (isset($o['is_awarded'])) $this->is_awarded = $o['is_awarded'];
if (isset($o['is_planned'])) $this->is_planned = $o['is_planned'];
if (isset($o['is_eligible'])) $this->is_eligible = $o['is_eligible'];
if (isset($o['award_amount'])) $this->award_amount = $o['award_amount'];
if (isset($o['award_budget'])) $this->award_budget = $o['award_budget'];
if (isset($o['comments'])) $this->comments = $o['comments'];
if (isset($o['term'])) $this->term = $o['term'];
if (isset($o['awarded_by'])) $this->awarded_by = $o['awarded_by'];
if (isset($o['awarded_date'])) $this->awarded_date = JsonConverters::from('DateTime', $o['awarded_date']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->award_code)) $o['award_code'] = $this->award_code;
if (isset($this->award_description)) $o['award_description'] = $this->award_description;
if (isset($this->is_awarded)) $o['is_awarded'] = $this->is_awarded;
if (isset($this->is_planned)) $o['is_planned'] = $this->is_planned;
if (isset($this->is_eligible)) $o['is_eligible'] = $this->is_eligible;
if (isset($this->award_amount)) $o['award_amount'] = $this->award_amount;
if (isset($this->award_budget)) $o['award_budget'] = $this->award_budget;
if (isset($this->comments)) $o['comments'] = $this->comments;
if (isset($this->term)) $o['term'] = $this->term;
if (isset($this->awarded_by)) $o['awarded_by'] = $this->awarded_by;
if (isset($this->awarded_date)) $o['awarded_date'] = JsonConverters::to('DateTime', $this->awarded_date);
return empty($o) ? new class(){} : $o;
}
}
class FinancialAidApplicationResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var string|null */
public ?string $start_term=null,
/** @var string|null */
public ?string $end_term=null,
/** @var int|null */
public ?int $number_of_terms=null,
/** @var int */
public int $regent_id=0,
/** @var string|null */
public ?string $uuid=null,
/** @var string|null */
public ?string $application_uuid=null,
/** @var array<FinancialAidApplicationAwardResponse>|null */
public ?array $awards=null,
/** @var array<FinancialAidApplicationAwardResponse>|null */
public ?array $previous_awards=null,
/** @var string|null */
public ?string $program=null,
/** @var string|null */
public ?string $gender=null,
/** @var string|null */
public ?string $first_name=null,
/** @var string|null */
public ?string $last_name=null,
/** @var string|null */
public ?string $email=null,
/** @var string|null */
public ?string $citizenship=null,
/** @var string|null */
public ?string $citizenship_other=null,
/** @var string|null */
public ?string $permanent_resident=null,
/** @var string|null */
public ?string $ethnicity=null,
/** @var string|null */
public ?string $marital_status=null,
/** @var DateTime|null */
public ?DateTime $dob=null,
/** @var string|null */
public ?string $addr1=null,
/** @var string|null */
public ?string $addr2=null,
/** @var string|null */
public ?string $city=null,
/** @var string|null */
public ?string $state=null,
/** @var string|null */
public ?string $country=null,
/** @var string|null */
public ?string $code=null,
/** @var string|null */
public ?string $denomination=null,
/** @var float|null */
public ?float $undergrad_gpa=null,
/** @var float|null */
public ?float $regent_gpa=null,
/** @var float|null */
public ?float $current_attempted_credits=null,
/** @var string|null */
public ?string $first_term_admitted=null,
/** @var float|null */
public ?float $current_attempted_and_transferred_credits=null,
/** @var float|null */
public ?float $current_award_term_attempted_credits=null,
/** @var int|null */
public ?int $number_of_children=null,
/** @var float|null */
public ?float $financial_assets=null,
/** @var float|null */
public ?float $spouse_income=null,
/** @var int|null */
public ?int $employment_years=null,
/** @var string|null */
public ?string $employment_description=null,
/** @var string|null */
public ?string $vocational_experience_json=null,
/** @var string|null */
public ?string $vocational_direction_json=null,
/** @var string|null */
public ?string $occupation_after_the_program_json=null,
/** @var string|null */
public ?string $area_of_study_json=null,
/** @var int */
public int $need_score=0,
/** @var int */
public int $merit_score=0,
/** @var int */
public int $score=0,
/** @var bool|null */
public ?bool $is_mature=null,
/** @var bool|null */
public ?bool $is_nonaccredited=null,
/** @var float|null */
public ?float $award_per_term=null,
/** @var float|null */
public ?float $amount_awarded=null,
/** @var float|null */
public ?float $oncampus_tuition_owing_in_term=null,
/** @var float|null */
public ?float $online_tuition_owing_in_term=null,
/** @var float|null */
public ?float $audit_and_fees_owing_in_term=null,
/** @var float|null */
public ?float $amount_offered=null,
/** @var float|null */
public ?float $total_amount_awarded=null,
/** @var string|null */
public ?string $comments=null,
/** @var string|null */
public ?string $current_status=null,
/** @var bool|null */
public ?bool $cannot_apply_again=null,
/** @var DateTime|null */
public ?DateTime $current_status_date=null,
/** @var DateTime|null */
public ?DateTime $started_date=null,
/** @var string|null */
public ?string $started_by=null,
/** @var DateTime|null */
public ?DateTime $submitted_date=null,
/** @var string|null */
public ?string $submitted_by=null,
/** @var DateTime|null */
public ?DateTime $changed_date=null,
/** @var string|null */
public ?string $changed_by=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
if (isset($o['start_term'])) $this->start_term = $o['start_term'];
if (isset($o['end_term'])) $this->end_term = $o['end_term'];
if (isset($o['number_of_terms'])) $this->number_of_terms = $o['number_of_terms'];
if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
if (isset($o['uuid'])) $this->uuid = $o['uuid'];
if (isset($o['application_uuid'])) $this->application_uuid = $o['application_uuid'];
if (isset($o['awards'])) $this->awards = JsonConverters::fromArray('FinancialAidApplicationAwardResponse', $o['awards']);
if (isset($o['previous_awards'])) $this->previous_awards = JsonConverters::fromArray('FinancialAidApplicationAwardResponse', $o['previous_awards']);
if (isset($o['program'])) $this->program = $o['program'];
if (isset($o['gender'])) $this->gender = $o['gender'];
if (isset($o['first_name'])) $this->first_name = $o['first_name'];
if (isset($o['last_name'])) $this->last_name = $o['last_name'];
if (isset($o['email'])) $this->email = $o['email'];
if (isset($o['citizenship'])) $this->citizenship = $o['citizenship'];
if (isset($o['citizenship_other'])) $this->citizenship_other = $o['citizenship_other'];
if (isset($o['permanent_resident'])) $this->permanent_resident = $o['permanent_resident'];
if (isset($o['ethnicity'])) $this->ethnicity = $o['ethnicity'];
if (isset($o['marital_status'])) $this->marital_status = $o['marital_status'];
if (isset($o['dob'])) $this->dob = JsonConverters::from('DateTime', $o['dob']);
if (isset($o['addr1'])) $this->addr1 = $o['addr1'];
if (isset($o['addr2'])) $this->addr2 = $o['addr2'];
if (isset($o['city'])) $this->city = $o['city'];
if (isset($o['state'])) $this->state = $o['state'];
if (isset($o['country'])) $this->country = $o['country'];
if (isset($o['code'])) $this->code = $o['code'];
if (isset($o['denomination'])) $this->denomination = $o['denomination'];
if (isset($o['undergrad_gpa'])) $this->undergrad_gpa = $o['undergrad_gpa'];
if (isset($o['regent_gpa'])) $this->regent_gpa = $o['regent_gpa'];
if (isset($o['current_attempted_credits'])) $this->current_attempted_credits = $o['current_attempted_credits'];
if (isset($o['first_term_admitted'])) $this->first_term_admitted = $o['first_term_admitted'];
if (isset($o['current_attempted_and_transferred_credits'])) $this->current_attempted_and_transferred_credits = $o['current_attempted_and_transferred_credits'];
if (isset($o['current_award_term_attempted_credits'])) $this->current_award_term_attempted_credits = $o['current_award_term_attempted_credits'];
if (isset($o['number_of_children'])) $this->number_of_children = $o['number_of_children'];
if (isset($o['financial_assets'])) $this->financial_assets = $o['financial_assets'];
if (isset($o['spouse_income'])) $this->spouse_income = $o['spouse_income'];
if (isset($o['employment_years'])) $this->employment_years = $o['employment_years'];
if (isset($o['employment_description'])) $this->employment_description = $o['employment_description'];
if (isset($o['vocational_experience_json'])) $this->vocational_experience_json = $o['vocational_experience_json'];
if (isset($o['vocational_direction_json'])) $this->vocational_direction_json = $o['vocational_direction_json'];
if (isset($o['occupation_after_the_program_json'])) $this->occupation_after_the_program_json = $o['occupation_after_the_program_json'];
if (isset($o['area_of_study_json'])) $this->area_of_study_json = $o['area_of_study_json'];
if (isset($o['need_score'])) $this->need_score = $o['need_score'];
if (isset($o['merit_score'])) $this->merit_score = $o['merit_score'];
if (isset($o['score'])) $this->score = $o['score'];
if (isset($o['is_mature'])) $this->is_mature = $o['is_mature'];
if (isset($o['is_nonaccredited'])) $this->is_nonaccredited = $o['is_nonaccredited'];
if (isset($o['award_per_term'])) $this->award_per_term = $o['award_per_term'];
if (isset($o['amount_awarded'])) $this->amount_awarded = $o['amount_awarded'];
if (isset($o['oncampus_tuition_owing_in_term'])) $this->oncampus_tuition_owing_in_term = $o['oncampus_tuition_owing_in_term'];
if (isset($o['online_tuition_owing_in_term'])) $this->online_tuition_owing_in_term = $o['online_tuition_owing_in_term'];
if (isset($o['audit_and_fees_owing_in_term'])) $this->audit_and_fees_owing_in_term = $o['audit_and_fees_owing_in_term'];
if (isset($o['amount_offered'])) $this->amount_offered = $o['amount_offered'];
if (isset($o['total_amount_awarded'])) $this->total_amount_awarded = $o['total_amount_awarded'];
if (isset($o['comments'])) $this->comments = $o['comments'];
if (isset($o['current_status'])) $this->current_status = $o['current_status'];
if (isset($o['cannot_apply_again'])) $this->cannot_apply_again = $o['cannot_apply_again'];
if (isset($o['current_status_date'])) $this->current_status_date = JsonConverters::from('DateTime', $o['current_status_date']);
if (isset($o['started_date'])) $this->started_date = JsonConverters::from('DateTime', $o['started_date']);
if (isset($o['started_by'])) $this->started_by = $o['started_by'];
if (isset($o['submitted_date'])) $this->submitted_date = JsonConverters::from('DateTime', $o['submitted_date']);
if (isset($o['submitted_by'])) $this->submitted_by = $o['submitted_by'];
if (isset($o['changed_date'])) $this->changed_date = JsonConverters::from('DateTime', $o['changed_date']);
if (isset($o['changed_by'])) $this->changed_by = $o['changed_by'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
if (isset($this->start_term)) $o['start_term'] = $this->start_term;
if (isset($this->end_term)) $o['end_term'] = $this->end_term;
if (isset($this->number_of_terms)) $o['number_of_terms'] = $this->number_of_terms;
if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
if (isset($this->uuid)) $o['uuid'] = $this->uuid;
if (isset($this->application_uuid)) $o['application_uuid'] = $this->application_uuid;
if (isset($this->awards)) $o['awards'] = JsonConverters::toArray('FinancialAidApplicationAwardResponse', $this->awards);
if (isset($this->previous_awards)) $o['previous_awards'] = JsonConverters::toArray('FinancialAidApplicationAwardResponse', $this->previous_awards);
if (isset($this->program)) $o['program'] = $this->program;
if (isset($this->gender)) $o['gender'] = $this->gender;
if (isset($this->first_name)) $o['first_name'] = $this->first_name;
if (isset($this->last_name)) $o['last_name'] = $this->last_name;
if (isset($this->email)) $o['email'] = $this->email;
if (isset($this->citizenship)) $o['citizenship'] = $this->citizenship;
if (isset($this->citizenship_other)) $o['citizenship_other'] = $this->citizenship_other;
if (isset($this->permanent_resident)) $o['permanent_resident'] = $this->permanent_resident;
if (isset($this->ethnicity)) $o['ethnicity'] = $this->ethnicity;
if (isset($this->marital_status)) $o['marital_status'] = $this->marital_status;
if (isset($this->dob)) $o['dob'] = JsonConverters::to('DateTime', $this->dob);
if (isset($this->addr1)) $o['addr1'] = $this->addr1;
if (isset($this->addr2)) $o['addr2'] = $this->addr2;
if (isset($this->city)) $o['city'] = $this->city;
if (isset($this->state)) $o['state'] = $this->state;
if (isset($this->country)) $o['country'] = $this->country;
if (isset($this->code)) $o['code'] = $this->code;
if (isset($this->denomination)) $o['denomination'] = $this->denomination;
if (isset($this->undergrad_gpa)) $o['undergrad_gpa'] = $this->undergrad_gpa;
if (isset($this->regent_gpa)) $o['regent_gpa'] = $this->regent_gpa;
if (isset($this->current_attempted_credits)) $o['current_attempted_credits'] = $this->current_attempted_credits;
if (isset($this->first_term_admitted)) $o['first_term_admitted'] = $this->first_term_admitted;
if (isset($this->current_attempted_and_transferred_credits)) $o['current_attempted_and_transferred_credits'] = $this->current_attempted_and_transferred_credits;
if (isset($this->current_award_term_attempted_credits)) $o['current_award_term_attempted_credits'] = $this->current_award_term_attempted_credits;
if (isset($this->number_of_children)) $o['number_of_children'] = $this->number_of_children;
if (isset($this->financial_assets)) $o['financial_assets'] = $this->financial_assets;
if (isset($this->spouse_income)) $o['spouse_income'] = $this->spouse_income;
if (isset($this->employment_years)) $o['employment_years'] = $this->employment_years;
if (isset($this->employment_description)) $o['employment_description'] = $this->employment_description;
if (isset($this->vocational_experience_json)) $o['vocational_experience_json'] = $this->vocational_experience_json;
if (isset($this->vocational_direction_json)) $o['vocational_direction_json'] = $this->vocational_direction_json;
if (isset($this->occupation_after_the_program_json)) $o['occupation_after_the_program_json'] = $this->occupation_after_the_program_json;
if (isset($this->area_of_study_json)) $o['area_of_study_json'] = $this->area_of_study_json;
if (isset($this->need_score)) $o['need_score'] = $this->need_score;
if (isset($this->merit_score)) $o['merit_score'] = $this->merit_score;
if (isset($this->score)) $o['score'] = $this->score;
if (isset($this->is_mature)) $o['is_mature'] = $this->is_mature;
if (isset($this->is_nonaccredited)) $o['is_nonaccredited'] = $this->is_nonaccredited;
if (isset($this->award_per_term)) $o['award_per_term'] = $this->award_per_term;
if (isset($this->amount_awarded)) $o['amount_awarded'] = $this->amount_awarded;
if (isset($this->oncampus_tuition_owing_in_term)) $o['oncampus_tuition_owing_in_term'] = $this->oncampus_tuition_owing_in_term;
if (isset($this->online_tuition_owing_in_term)) $o['online_tuition_owing_in_term'] = $this->online_tuition_owing_in_term;
if (isset($this->audit_and_fees_owing_in_term)) $o['audit_and_fees_owing_in_term'] = $this->audit_and_fees_owing_in_term;
if (isset($this->amount_offered)) $o['amount_offered'] = $this->amount_offered;
if (isset($this->total_amount_awarded)) $o['total_amount_awarded'] = $this->total_amount_awarded;
if (isset($this->comments)) $o['comments'] = $this->comments;
if (isset($this->current_status)) $o['current_status'] = $this->current_status;
if (isset($this->cannot_apply_again)) $o['cannot_apply_again'] = $this->cannot_apply_again;
if (isset($this->current_status_date)) $o['current_status_date'] = JsonConverters::to('DateTime', $this->current_status_date);
if (isset($this->started_date)) $o['started_date'] = JsonConverters::to('DateTime', $this->started_date);
if (isset($this->started_by)) $o['started_by'] = $this->started_by;
if (isset($this->submitted_date)) $o['submitted_date'] = JsonConverters::to('DateTime', $this->submitted_date);
if (isset($this->submitted_by)) $o['submitted_by'] = $this->submitted_by;
if (isset($this->changed_date)) $o['changed_date'] = JsonConverters::to('DateTime', $this->changed_date);
if (isset($this->changed_by)) $o['changed_by'] = $this->changed_by;
return empty($o) ? new class(){} : $o;
}
}
class FinancialAidApplicationRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $uuid=null,
/** @var string|null */
public ?string $start_term=null,
/** @var string|null */
public ?string $application_uuid=null,
/** @var string|null */
public ?string $awards_in_term=null,
/** @var bool|null */
public ?bool $no_awards_in_response=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['uuid'])) $this->uuid = $o['uuid'];
if (isset($o['start_term'])) $this->start_term = $o['start_term'];
if (isset($o['application_uuid'])) $this->application_uuid = $o['application_uuid'];
if (isset($o['awards_in_term'])) $this->awards_in_term = $o['awards_in_term'];
if (isset($o['no_awards_in_response'])) $this->no_awards_in_response = $o['no_awards_in_response'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->uuid)) $o['uuid'] = $this->uuid;
if (isset($this->start_term)) $o['start_term'] = $this->start_term;
if (isset($this->application_uuid)) $o['application_uuid'] = $this->application_uuid;
if (isset($this->awards_in_term)) $o['awards_in_term'] = $this->awards_in_term;
if (isset($this->no_awards_in_response)) $o['no_awards_in_response'] = $this->no_awards_in_response;
return empty($o) ? new class(){} : $o;
}
}
PHP 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
}