| Required role: | REGISUserRole |
| POST | /Finance/FinancialAid/AllocationReview/{reporting_term} |
|---|
export class FinancialAidAllocationCandidateResponse
{
public application_uuid: string;
public uuid: string;
public regent_id: number;
public first_name: string;
public last_name: string;
public application_start_term: string;
public current_status: string;
public submitted_date?: string;
public eligibility_tier: string;
public award_target: number;
public committed_amount: number;
public unmet_amount: number;
public proposed_amount: number;
public incomplete_reason: string;
public constructor(init?: Partial<FinancialAidAllocationCandidateResponse>) { (Object as any).assign(this, init); }
}
export class FinancialAidAllocationCycleResponse
{
public application_start_term: string;
public is_fallback_released: boolean;
public fallback_release_date?: string;
public fallback_released_by: string;
public primary_candidates: FinancialAidAllocationCandidateResponse[];
public fallback_candidates: FinancialAidAllocationCandidateResponse[];
public manual_review_candidates: FinancialAidAllocationCandidateResponse[];
public constructor(init?: Partial<FinancialAidAllocationCycleResponse>) { (Object as any).assign(this, init); }
}
export class FinancialAidAllocationProposalResponse
{
public application_uuid: string;
public regent_id: number;
public student_name: string;
public application_start_term: string;
public eligibility_tier: string;
public amount: number;
public constructor(init?: Partial<FinancialAidAllocationProposalResponse>) { (Object as any).assign(this, init); }
}
export class FinancialAidAllocationAwardResponse
{
public award_code: string;
public award_description: string;
public budget_amount: number;
public planned_or_offered_amount: number;
public accepted_or_issued_amount: number;
public committed_amount: number;
public reclaimable_amount: number;
public proposed_amount: number;
public projected_remaining_amount: number;
public must_award_whole_budget: boolean;
public requires_manual_review: boolean;
public manual_review_note: string;
public required_recipient_count?: number;
public requires_equal_shares: boolean;
public application_cycles: FinancialAidAllocationCycleResponse[];
public proposals: FinancialAidAllocationProposalResponse[];
public constructor(init?: Partial<FinancialAidAllocationAwardResponse>) { (Object as any).assign(this, init); }
}
export class FinancialAidAllocationConflictResponse
{
public award_code: string;
public award_description: string;
public application_start_term: string;
public fallback_application_uuid: string;
public fallback_student_name: string;
public fallback_status: string;
public reclaimable_amount: number;
public primary_application_uuid: string;
public primary_student_name: string;
public constructor(init?: Partial<FinancialAidAllocationConflictResponse>) { (Object as any).assign(this, init); }
}
export class FinancialAidAllocationReviewResponse
{
public responseStatus: ResponseStatus;
public reporting_term: string;
public budget_amount: number;
public committed_amount: number;
public proposed_amount: number;
public projected_unused_amount: number;
public actionable_unmet_amount: number;
public awards: FinancialAidAllocationAwardResponse[];
public incomplete_candidates: FinancialAidAllocationCandidateResponse[];
public conflicts: FinancialAidAllocationConflictResponse[];
public constructor(init?: Partial<FinancialAidAllocationReviewResponse>) { (Object as any).assign(this, init); }
}
export class FinancialAidAllocationReviewRequest
{
public reporting_term: string;
public authorizing_uuid: string;
public constructor(init?: Partial<FinancialAidAllocationReviewRequest>) { (Object as any).assign(this, init); }
}
TypeScript FinancialAidAllocationReviewRequest 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/AllocationReview/{reporting_term} HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
reporting_term: String,
authorizing_uuid: String
}
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
}
},
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-01,
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-01,
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-01,
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-01,
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-01,
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
}
]
}