| Required role: | REGISUserRole |
| POST | /Finance/FinancialAid/AllocationReview/{reporting_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 FinancialAidAllocationCandidateResponse implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $application_uuid=null,
/** @var string|null */
public ?string $uuid=null,
/** @var int */
public int $regent_id=0,
/** @var string|null */
public ?string $first_name=null,
/** @var string|null */
public ?string $last_name=null,
/** @var string|null */
public ?string $application_start_term=null,
/** @var string|null */
public ?string $current_status=null,
/** @var DateTime|null */
public ?DateTime $submitted_date=null,
/** @var string|null */
public ?string $eligibility_tier=null,
/** @var float */
public float $award_target=0.0,
/** @var float */
public float $committed_amount=0.0,
/** @var float */
public float $unmet_amount=0.0,
/** @var float */
public float $proposed_amount=0.0,
/** @var string|null */
public ?string $incomplete_reason=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['application_uuid'])) $this->application_uuid = $o['application_uuid'];
if (isset($o['uuid'])) $this->uuid = $o['uuid'];
if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
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['application_start_term'])) $this->application_start_term = $o['application_start_term'];
if (isset($o['current_status'])) $this->current_status = $o['current_status'];
if (isset($o['submitted_date'])) $this->submitted_date = JsonConverters::from('DateTime', $o['submitted_date']);
if (isset($o['eligibility_tier'])) $this->eligibility_tier = $o['eligibility_tier'];
if (isset($o['award_target'])) $this->award_target = $o['award_target'];
if (isset($o['committed_amount'])) $this->committed_amount = $o['committed_amount'];
if (isset($o['unmet_amount'])) $this->unmet_amount = $o['unmet_amount'];
if (isset($o['proposed_amount'])) $this->proposed_amount = $o['proposed_amount'];
if (isset($o['incomplete_reason'])) $this->incomplete_reason = $o['incomplete_reason'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->application_uuid)) $o['application_uuid'] = $this->application_uuid;
if (isset($this->uuid)) $o['uuid'] = $this->uuid;
if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
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->application_start_term)) $o['application_start_term'] = $this->application_start_term;
if (isset($this->current_status)) $o['current_status'] = $this->current_status;
if (isset($this->submitted_date)) $o['submitted_date'] = JsonConverters::to('DateTime', $this->submitted_date);
if (isset($this->eligibility_tier)) $o['eligibility_tier'] = $this->eligibility_tier;
if (isset($this->award_target)) $o['award_target'] = $this->award_target;
if (isset($this->committed_amount)) $o['committed_amount'] = $this->committed_amount;
if (isset($this->unmet_amount)) $o['unmet_amount'] = $this->unmet_amount;
if (isset($this->proposed_amount)) $o['proposed_amount'] = $this->proposed_amount;
if (isset($this->incomplete_reason)) $o['incomplete_reason'] = $this->incomplete_reason;
return empty($o) ? new class(){} : $o;
}
}
class FinancialAidAllocationCycleResponse implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $application_start_term=null,
/** @var bool|null */
public ?bool $is_fallback_released=null,
/** @var DateTime|null */
public ?DateTime $fallback_release_date=null,
/** @var string|null */
public ?string $fallback_released_by=null,
/** @var array<FinancialAidAllocationCandidateResponse>|null */
public ?array $primary_candidates=null,
/** @var array<FinancialAidAllocationCandidateResponse>|null */
public ?array $fallback_candidates=null,
/** @var array<FinancialAidAllocationCandidateResponse>|null */
public ?array $manual_review_candidates=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['application_start_term'])) $this->application_start_term = $o['application_start_term'];
if (isset($o['is_fallback_released'])) $this->is_fallback_released = $o['is_fallback_released'];
if (isset($o['fallback_release_date'])) $this->fallback_release_date = JsonConverters::from('DateTime', $o['fallback_release_date']);
if (isset($o['fallback_released_by'])) $this->fallback_released_by = $o['fallback_released_by'];
if (isset($o['primary_candidates'])) $this->primary_candidates = JsonConverters::fromArray('FinancialAidAllocationCandidateResponse', $o['primary_candidates']);
if (isset($o['fallback_candidates'])) $this->fallback_candidates = JsonConverters::fromArray('FinancialAidAllocationCandidateResponse', $o['fallback_candidates']);
if (isset($o['manual_review_candidates'])) $this->manual_review_candidates = JsonConverters::fromArray('FinancialAidAllocationCandidateResponse', $o['manual_review_candidates']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->application_start_term)) $o['application_start_term'] = $this->application_start_term;
if (isset($this->is_fallback_released)) $o['is_fallback_released'] = $this->is_fallback_released;
if (isset($this->fallback_release_date)) $o['fallback_release_date'] = JsonConverters::to('DateTime', $this->fallback_release_date);
if (isset($this->fallback_released_by)) $o['fallback_released_by'] = $this->fallback_released_by;
if (isset($this->primary_candidates)) $o['primary_candidates'] = JsonConverters::toArray('FinancialAidAllocationCandidateResponse', $this->primary_candidates);
if (isset($this->fallback_candidates)) $o['fallback_candidates'] = JsonConverters::toArray('FinancialAidAllocationCandidateResponse', $this->fallback_candidates);
if (isset($this->manual_review_candidates)) $o['manual_review_candidates'] = JsonConverters::toArray('FinancialAidAllocationCandidateResponse', $this->manual_review_candidates);
return empty($o) ? new class(){} : $o;
}
}
class FinancialAidAllocationProposalResponse implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $application_uuid=null,
/** @var int */
public int $regent_id=0,
/** @var string|null */
public ?string $student_name=null,
/** @var string|null */
public ?string $application_start_term=null,
/** @var string|null */
public ?string $eligibility_tier=null,
/** @var float */
public float $amount=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['application_uuid'])) $this->application_uuid = $o['application_uuid'];
if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
if (isset($o['student_name'])) $this->student_name = $o['student_name'];
if (isset($o['application_start_term'])) $this->application_start_term = $o['application_start_term'];
if (isset($o['eligibility_tier'])) $this->eligibility_tier = $o['eligibility_tier'];
if (isset($o['amount'])) $this->amount = $o['amount'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->application_uuid)) $o['application_uuid'] = $this->application_uuid;
if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
if (isset($this->student_name)) $o['student_name'] = $this->student_name;
if (isset($this->application_start_term)) $o['application_start_term'] = $this->application_start_term;
if (isset($this->eligibility_tier)) $o['eligibility_tier'] = $this->eligibility_tier;
if (isset($this->amount)) $o['amount'] = $this->amount;
return empty($o) ? new class(){} : $o;
}
}
class FinancialAidAllocationAwardResponse implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $award_code=null,
/** @var string|null */
public ?string $award_description=null,
/** @var float */
public float $budget_amount=0.0,
/** @var float */
public float $planned_or_offered_amount=0.0,
/** @var float */
public float $accepted_or_issued_amount=0.0,
/** @var float */
public float $committed_amount=0.0,
/** @var float */
public float $reclaimable_amount=0.0,
/** @var float */
public float $proposed_amount=0.0,
/** @var float */
public float $projected_remaining_amount=0.0,
/** @var bool|null */
public ?bool $must_award_whole_budget=null,
/** @var bool|null */
public ?bool $requires_manual_review=null,
/** @var string|null */
public ?string $manual_review_note=null,
/** @var int|null */
public ?int $required_recipient_count=null,
/** @var bool|null */
public ?bool $requires_equal_shares=null,
/** @var array<FinancialAidAllocationCycleResponse>|null */
public ?array $application_cycles=null,
/** @var array<FinancialAidAllocationProposalResponse>|null */
public ?array $proposals=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
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['budget_amount'])) $this->budget_amount = $o['budget_amount'];
if (isset($o['planned_or_offered_amount'])) $this->planned_or_offered_amount = $o['planned_or_offered_amount'];
if (isset($o['accepted_or_issued_amount'])) $this->accepted_or_issued_amount = $o['accepted_or_issued_amount'];
if (isset($o['committed_amount'])) $this->committed_amount = $o['committed_amount'];
if (isset($o['reclaimable_amount'])) $this->reclaimable_amount = $o['reclaimable_amount'];
if (isset($o['proposed_amount'])) $this->proposed_amount = $o['proposed_amount'];
if (isset($o['projected_remaining_amount'])) $this->projected_remaining_amount = $o['projected_remaining_amount'];
if (isset($o['must_award_whole_budget'])) $this->must_award_whole_budget = $o['must_award_whole_budget'];
if (isset($o['requires_manual_review'])) $this->requires_manual_review = $o['requires_manual_review'];
if (isset($o['manual_review_note'])) $this->manual_review_note = $o['manual_review_note'];
if (isset($o['required_recipient_count'])) $this->required_recipient_count = $o['required_recipient_count'];
if (isset($o['requires_equal_shares'])) $this->requires_equal_shares = $o['requires_equal_shares'];
if (isset($o['application_cycles'])) $this->application_cycles = JsonConverters::fromArray('FinancialAidAllocationCycleResponse', $o['application_cycles']);
if (isset($o['proposals'])) $this->proposals = JsonConverters::fromArray('FinancialAidAllocationProposalResponse', $o['proposals']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
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->budget_amount)) $o['budget_amount'] = $this->budget_amount;
if (isset($this->planned_or_offered_amount)) $o['planned_or_offered_amount'] = $this->planned_or_offered_amount;
if (isset($this->accepted_or_issued_amount)) $o['accepted_or_issued_amount'] = $this->accepted_or_issued_amount;
if (isset($this->committed_amount)) $o['committed_amount'] = $this->committed_amount;
if (isset($this->reclaimable_amount)) $o['reclaimable_amount'] = $this->reclaimable_amount;
if (isset($this->proposed_amount)) $o['proposed_amount'] = $this->proposed_amount;
if (isset($this->projected_remaining_amount)) $o['projected_remaining_amount'] = $this->projected_remaining_amount;
if (isset($this->must_award_whole_budget)) $o['must_award_whole_budget'] = $this->must_award_whole_budget;
if (isset($this->requires_manual_review)) $o['requires_manual_review'] = $this->requires_manual_review;
if (isset($this->manual_review_note)) $o['manual_review_note'] = $this->manual_review_note;
if (isset($this->required_recipient_count)) $o['required_recipient_count'] = $this->required_recipient_count;
if (isset($this->requires_equal_shares)) $o['requires_equal_shares'] = $this->requires_equal_shares;
if (isset($this->application_cycles)) $o['application_cycles'] = JsonConverters::toArray('FinancialAidAllocationCycleResponse', $this->application_cycles);
if (isset($this->proposals)) $o['proposals'] = JsonConverters::toArray('FinancialAidAllocationProposalResponse', $this->proposals);
return empty($o) ? new class(){} : $o;
}
}
class FinancialAidAllocationConflictResponse implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $award_code=null,
/** @var string|null */
public ?string $award_description=null,
/** @var string|null */
public ?string $application_start_term=null,
/** @var string|null */
public ?string $fallback_application_uuid=null,
/** @var string|null */
public ?string $fallback_student_name=null,
/** @var string|null */
public ?string $fallback_status=null,
/** @var float */
public float $reclaimable_amount=0.0,
/** @var string|null */
public ?string $primary_application_uuid=null,
/** @var string|null */
public ?string $primary_student_name=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
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['application_start_term'])) $this->application_start_term = $o['application_start_term'];
if (isset($o['fallback_application_uuid'])) $this->fallback_application_uuid = $o['fallback_application_uuid'];
if (isset($o['fallback_student_name'])) $this->fallback_student_name = $o['fallback_student_name'];
if (isset($o['fallback_status'])) $this->fallback_status = $o['fallback_status'];
if (isset($o['reclaimable_amount'])) $this->reclaimable_amount = $o['reclaimable_amount'];
if (isset($o['primary_application_uuid'])) $this->primary_application_uuid = $o['primary_application_uuid'];
if (isset($o['primary_student_name'])) $this->primary_student_name = $o['primary_student_name'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
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->application_start_term)) $o['application_start_term'] = $this->application_start_term;
if (isset($this->fallback_application_uuid)) $o['fallback_application_uuid'] = $this->fallback_application_uuid;
if (isset($this->fallback_student_name)) $o['fallback_student_name'] = $this->fallback_student_name;
if (isset($this->fallback_status)) $o['fallback_status'] = $this->fallback_status;
if (isset($this->reclaimable_amount)) $o['reclaimable_amount'] = $this->reclaimable_amount;
if (isset($this->primary_application_uuid)) $o['primary_application_uuid'] = $this->primary_application_uuid;
if (isset($this->primary_student_name)) $o['primary_student_name'] = $this->primary_student_name;
return empty($o) ? new class(){} : $o;
}
}
class FinancialAidAllocationReviewResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var string|null */
public ?string $reporting_term=null,
/** @var float */
public float $budget_amount=0.0,
/** @var float */
public float $committed_amount=0.0,
/** @var float */
public float $proposed_amount=0.0,
/** @var float */
public float $projected_unused_amount=0.0,
/** @var float */
public float $actionable_unmet_amount=0.0,
/** @var array<FinancialAidAllocationAwardResponse>|null */
public ?array $awards=null,
/** @var array<FinancialAidAllocationCandidateResponse>|null */
public ?array $incomplete_candidates=null,
/** @var array<FinancialAidAllocationConflictResponse>|null */
public ?array $conflicts=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
if (isset($o['budget_amount'])) $this->budget_amount = $o['budget_amount'];
if (isset($o['committed_amount'])) $this->committed_amount = $o['committed_amount'];
if (isset($o['proposed_amount'])) $this->proposed_amount = $o['proposed_amount'];
if (isset($o['projected_unused_amount'])) $this->projected_unused_amount = $o['projected_unused_amount'];
if (isset($o['actionable_unmet_amount'])) $this->actionable_unmet_amount = $o['actionable_unmet_amount'];
if (isset($o['awards'])) $this->awards = JsonConverters::fromArray('FinancialAidAllocationAwardResponse', $o['awards']);
if (isset($o['incomplete_candidates'])) $this->incomplete_candidates = JsonConverters::fromArray('FinancialAidAllocationCandidateResponse', $o['incomplete_candidates']);
if (isset($o['conflicts'])) $this->conflicts = JsonConverters::fromArray('FinancialAidAllocationConflictResponse', $o['conflicts']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
if (isset($this->budget_amount)) $o['budget_amount'] = $this->budget_amount;
if (isset($this->committed_amount)) $o['committed_amount'] = $this->committed_amount;
if (isset($this->proposed_amount)) $o['proposed_amount'] = $this->proposed_amount;
if (isset($this->projected_unused_amount)) $o['projected_unused_amount'] = $this->projected_unused_amount;
if (isset($this->actionable_unmet_amount)) $o['actionable_unmet_amount'] = $this->actionable_unmet_amount;
if (isset($this->awards)) $o['awards'] = JsonConverters::toArray('FinancialAidAllocationAwardResponse', $this->awards);
if (isset($this->incomplete_candidates)) $o['incomplete_candidates'] = JsonConverters::toArray('FinancialAidAllocationCandidateResponse', $this->incomplete_candidates);
if (isset($this->conflicts)) $o['conflicts'] = JsonConverters::toArray('FinancialAidAllocationConflictResponse', $this->conflicts);
return empty($o) ? new class(){} : $o;
}
}
class FinancialAidAllocationReviewRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $reporting_term=null,
/** @var string|null */
public ?string $authorizing_uuid=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
return empty($o) ? new class(){} : $o;
}
}
PHP FinancialAidAllocationReviewRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Finance/FinancialAid/AllocationReview/{reporting_term} HTTP/1.1
Host: data.regent-college.edu
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"reporting_term":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"reporting_term":"String","budget_amount":0,"committed_amount":0,"proposed_amount":0,"projected_unused_amount":0,"actionable_unmet_amount":0,"awards":[{"award_code":"String","award_description":"String","budget_amount":0,"planned_or_offered_amount":0,"accepted_or_issued_amount":0,"committed_amount":0,"reclaimable_amount":0,"proposed_amount":0,"projected_remaining_amount":0,"must_award_whole_budget":false,"requires_manual_review":false,"manual_review_note":"String","required_recipient_count":0,"requires_equal_shares":false,"application_cycles":[{"application_start_term":"String","is_fallback_released":false,"fallback_release_date":"0001-01-01T00:00:00.0000000","fallback_released_by":"String","primary_candidates":[{"application_uuid":"String","uuid":"String","regent_id":0,"first_name":"String","last_name":"String","application_start_term":"String","current_status":"String","submitted_date":"0001-01-01T00:00:00.0000000","eligibility_tier":"String","award_target":0,"committed_amount":0,"unmet_amount":0,"proposed_amount":0,"incomplete_reason":"String"}],"fallback_candidates":[{"application_uuid":"String","uuid":"String","regent_id":0,"first_name":"String","last_name":"String","application_start_term":"String","current_status":"String","submitted_date":"0001-01-01T00:00:00.0000000","eligibility_tier":"String","award_target":0,"committed_amount":0,"unmet_amount":0,"proposed_amount":0,"incomplete_reason":"String"}],"manual_review_candidates":[{"application_uuid":"String","uuid":"String","regent_id":0,"first_name":"String","last_name":"String","application_start_term":"String","current_status":"String","submitted_date":"0001-01-01T00:00:00.0000000","eligibility_tier":"String","award_target":0,"committed_amount":0,"unmet_amount":0,"proposed_amount":0,"incomplete_reason":"String"}]}],"proposals":[{"application_uuid":"String","regent_id":0,"student_name":"String","application_start_term":"String","eligibility_tier":"String","amount":0}]}],"incomplete_candidates":[{"application_uuid":"String","uuid":"String","regent_id":0,"first_name":"String","last_name":"String","application_start_term":"String","current_status":"String","submitted_date":"0001-01-01T00:00:00.0000000","eligibility_tier":"String","award_target":0,"committed_amount":0,"unmet_amount":0,"proposed_amount":0,"incomplete_reason":"String"}],"conflicts":[{"award_code":"String","award_description":"String","application_start_term":"String","fallback_application_uuid":"String","fallback_student_name":"String","fallback_status":"String","reclaimable_amount":0,"primary_application_uuid":"String","primary_student_name":"String"}]}