| Required role: | REGISUserRole |
| POST | /Finance/FinancialAid/AllocationReview/{reporting_term} |
|---|
namespace regis.ClassLibrary.Requests
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type FinancialAidAllocationCandidateResponse() =
member val application_uuid:String = null with get,set
member val uuid:String = null with get,set
member val regent_id:Int32 = new Int32() with get,set
member val first_name:String = null with get,set
member val last_name:String = null with get,set
member val application_start_term:String = null with get,set
member val current_status:String = null with get,set
member val submitted_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val eligibility_tier:String = null with get,set
member val award_target:Decimal = new Decimal() with get,set
member val committed_amount:Decimal = new Decimal() with get,set
member val unmet_amount:Decimal = new Decimal() with get,set
member val proposed_amount:Decimal = new Decimal() with get,set
member val incomplete_reason:String = null with get,set
[<AllowNullLiteral>]
type FinancialAidAllocationCycleResponse() =
member val application_start_term:String = null with get,set
member val is_fallback_released:Boolean = new Boolean() with get,set
member val fallback_release_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val fallback_released_by:String = null with get,set
member val primary_candidates:ResizeArray<FinancialAidAllocationCandidateResponse> = new ResizeArray<FinancialAidAllocationCandidateResponse>() with get,set
member val fallback_candidates:ResizeArray<FinancialAidAllocationCandidateResponse> = new ResizeArray<FinancialAidAllocationCandidateResponse>() with get,set
member val manual_review_candidates:ResizeArray<FinancialAidAllocationCandidateResponse> = new ResizeArray<FinancialAidAllocationCandidateResponse>() with get,set
[<AllowNullLiteral>]
type FinancialAidAllocationProposalResponse() =
member val application_uuid:String = null with get,set
member val regent_id:Int32 = new Int32() with get,set
member val student_name:String = null with get,set
member val application_start_term:String = null with get,set
member val eligibility_tier:String = null with get,set
member val amount:Decimal = new Decimal() with get,set
[<AllowNullLiteral>]
type FinancialAidAllocationAwardResponse() =
member val award_code:String = null with get,set
member val award_description:String = null with get,set
member val budget_amount:Decimal = new Decimal() with get,set
member val planned_or_offered_amount:Decimal = new Decimal() with get,set
member val accepted_or_issued_amount:Decimal = new Decimal() with get,set
member val committed_amount:Decimal = new Decimal() with get,set
member val reclaimable_amount:Decimal = new Decimal() with get,set
member val proposed_amount:Decimal = new Decimal() with get,set
member val projected_remaining_amount:Decimal = new Decimal() with get,set
member val must_award_whole_budget:Boolean = new Boolean() with get,set
member val requires_manual_review:Boolean = new Boolean() with get,set
member val manual_review_note:String = null with get,set
member val required_recipient_count:Nullable<Int32> = new Nullable<Int32>() with get,set
member val requires_equal_shares:Boolean = new Boolean() with get,set
member val application_cycles:ResizeArray<FinancialAidAllocationCycleResponse> = new ResizeArray<FinancialAidAllocationCycleResponse>() with get,set
member val proposals:ResizeArray<FinancialAidAllocationProposalResponse> = new ResizeArray<FinancialAidAllocationProposalResponse>() with get,set
[<AllowNullLiteral>]
type FinancialAidAllocationConflictResponse() =
member val award_code:String = null with get,set
member val award_description:String = null with get,set
member val application_start_term:String = null with get,set
member val fallback_application_uuid:String = null with get,set
member val fallback_student_name:String = null with get,set
member val fallback_status:String = null with get,set
member val reclaimable_amount:Decimal = new Decimal() with get,set
member val primary_application_uuid:String = null with get,set
member val primary_student_name:String = null with get,set
[<AllowNullLiteral>]
type FinancialAidAllocationReviewResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val reporting_term:String = null with get,set
member val budget_amount:Decimal = new Decimal() with get,set
member val committed_amount:Decimal = new Decimal() with get,set
member val proposed_amount:Decimal = new Decimal() with get,set
member val projected_unused_amount:Decimal = new Decimal() with get,set
member val actionable_unmet_amount:Decimal = new Decimal() with get,set
member val awards:ResizeArray<FinancialAidAllocationAwardResponse> = new ResizeArray<FinancialAidAllocationAwardResponse>() with get,set
member val incomplete_candidates:ResizeArray<FinancialAidAllocationCandidateResponse> = new ResizeArray<FinancialAidAllocationCandidateResponse>() with get,set
member val conflicts:ResizeArray<FinancialAidAllocationConflictResponse> = new ResizeArray<FinancialAidAllocationConflictResponse>() with get,set
[<AllowNullLiteral>]
type FinancialAidAllocationReviewRequest() =
member val reporting_term:String = null with get,set
member val authorizing_uuid:String = null with get,set
F# 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"}]}