regis

FinancialAidAllocationReviewRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Finance/FinancialAid/AllocationReview/{reporting_term}

**FinancialAidAllocationReviewRequest** Parameters:
Name	Parameter	Data Type	Required	Description
reporting_term	path	string	No
authorizing_uuid	body	string	No

**FinancialAidAllocationReviewResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
reporting_term	form	string	No
budget_amount	form	decimal	No
committed_amount	form	decimal	No
proposed_amount	form	decimal	No
projected_unused_amount	form	decimal	No
actionable_unmet_amount	form	decimal	No
awards	form	List<FinancialAidAllocationAwardResponse>	No
incomplete_candidates	form	List<FinancialAidAllocationCandidateResponse>	No
conflicts	form	List<FinancialAidAllocationConflictResponse>	No

**FinancialAidAllocationAwardResponse** Parameters:
Name	Parameter	Data Type	Required
award_code	form	string	No
award_description	form	string	No
budget_amount	form	decimal	No
planned_or_offered_amount	form	decimal	No
accepted_or_issued_amount	form	decimal	No
committed_amount	form	decimal	No
reclaimable_amount	form	decimal	No
proposed_amount	form	decimal	No
projected_remaining_amount	form	decimal	No
must_award_whole_budget	form	bool	No
requires_manual_review	form	bool	No
manual_review_note	form	string	No
required_recipient_count	form	int?	No
requires_equal_shares	form	bool	No
application_cycles	form	List<FinancialAidAllocationCycleResponse>	No
proposals	form	List<FinancialAidAllocationProposalResponse>	No

**FinancialAidAllocationCycleResponse** Parameters:
Name	Parameter	Data Type	Required
application_start_term	form	string	No
is_fallback_released	form	bool	No
fallback_release_date	form	DateTime?	No
fallback_released_by	form	string	No
primary_candidates	form	List<FinancialAidAllocationCandidateResponse>	No
fallback_candidates	form	List<FinancialAidAllocationCandidateResponse>	No
manual_review_candidates	form	List<FinancialAidAllocationCandidateResponse>	No

**FinancialAidAllocationCandidateResponse** Parameters:
Name	Parameter	Data Type	Required
application_uuid	form	string	No
uuid	form	string	No
regent_id	form	int	No
first_name	form	string	No
last_name	form	string	No
application_start_term	form	string	No
current_status	form	string	No
submitted_date	form	DateTime?	No
eligibility_tier	form	string	No
award_target	form	decimal	No
committed_amount	form	decimal	No
unmet_amount	form	decimal	No
proposed_amount	form	decimal	No
incomplete_reason	form	string	No

**FinancialAidAllocationProposalResponse** Parameters:
Name	Parameter	Data Type	Required
application_uuid	form	string	No
regent_id	form	int	No
student_name	form	string	No
application_start_term	form	string	No
eligibility_tier	form	string	No
amount	form	decimal	No

**FinancialAidAllocationConflictResponse** Parameters:
Name	Parameter	Data Type	Required
award_code	form	string	No
award_description	form	string	No
application_start_term	form	string	No
fallback_application_uuid	form	string	No
fallback_student_name	form	string	No
fallback_status	form	string	No
reclaimable_amount	form	decimal	No
primary_application_uuid	form	string	No
primary_student_name	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"reporting_term":"String","authorizing_uuid":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}]}