| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<FinancialAidAllocationReviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<authorizing_uuid>String</authorizing_uuid>
<reporting_term>String</reporting_term>
</FinancialAidAllocationReviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FinancialAidAllocationReviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<actionable_unmet_amount>0</actionable_unmet_amount>
<awards>
<FinancialAidAllocationAwardResponse>
<accepted_or_issued_amount>0</accepted_or_issued_amount>
<application_cycles>
<FinancialAidAllocationCycleResponse>
<application_start_term>String</application_start_term>
<fallback_candidates>
<FinancialAidAllocationCandidateResponse>
<application_start_term>String</application_start_term>
<application_uuid>String</application_uuid>
<award_target>0</award_target>
<committed_amount>0</committed_amount>
<current_status>String</current_status>
<eligibility_tier>String</eligibility_tier>
<first_name>String</first_name>
<incomplete_reason>String</incomplete_reason>
<last_name>String</last_name>
<proposed_amount>0</proposed_amount>
<regent_id>0</regent_id>
<submitted_date>0001-01-01T00:00:00</submitted_date>
<unmet_amount>0</unmet_amount>
<uuid>String</uuid>
</FinancialAidAllocationCandidateResponse>
</fallback_candidates>
<fallback_release_date>0001-01-01T00:00:00</fallback_release_date>
<fallback_released_by>String</fallback_released_by>
<is_fallback_released>false</is_fallback_released>
<manual_review_candidates>
<FinancialAidAllocationCandidateResponse>
<application_start_term>String</application_start_term>
<application_uuid>String</application_uuid>
<award_target>0</award_target>
<committed_amount>0</committed_amount>
<current_status>String</current_status>
<eligibility_tier>String</eligibility_tier>
<first_name>String</first_name>
<incomplete_reason>String</incomplete_reason>
<last_name>String</last_name>
<proposed_amount>0</proposed_amount>
<regent_id>0</regent_id>
<submitted_date>0001-01-01T00:00:00</submitted_date>
<unmet_amount>0</unmet_amount>
<uuid>String</uuid>
</FinancialAidAllocationCandidateResponse>
</manual_review_candidates>
<primary_candidates>
<FinancialAidAllocationCandidateResponse>
<application_start_term>String</application_start_term>
<application_uuid>String</application_uuid>
<award_target>0</award_target>
<committed_amount>0</committed_amount>
<current_status>String</current_status>
<eligibility_tier>String</eligibility_tier>
<first_name>String</first_name>
<incomplete_reason>String</incomplete_reason>
<last_name>String</last_name>
<proposed_amount>0</proposed_amount>
<regent_id>0</regent_id>
<submitted_date>0001-01-01T00:00:00</submitted_date>
<unmet_amount>0</unmet_amount>
<uuid>String</uuid>
</FinancialAidAllocationCandidateResponse>
</primary_candidates>
</FinancialAidAllocationCycleResponse>
</application_cycles>
<award_code>String</award_code>
<award_description>String</award_description>
<budget_amount>0</budget_amount>
<committed_amount>0</committed_amount>
<manual_review_note>String</manual_review_note>
<must_award_whole_budget>false</must_award_whole_budget>
<planned_or_offered_amount>0</planned_or_offered_amount>
<projected_remaining_amount>0</projected_remaining_amount>
<proposals>
<FinancialAidAllocationProposalResponse>
<amount>0</amount>
<application_start_term>String</application_start_term>
<application_uuid>String</application_uuid>
<eligibility_tier>String</eligibility_tier>
<regent_id>0</regent_id>
<student_name>String</student_name>
</FinancialAidAllocationProposalResponse>
</proposals>
<proposed_amount>0</proposed_amount>
<reclaimable_amount>0</reclaimable_amount>
<required_recipient_count>0</required_recipient_count>
<requires_equal_shares>false</requires_equal_shares>
<requires_manual_review>false</requires_manual_review>
</FinancialAidAllocationAwardResponse>
</awards>
<budget_amount>0</budget_amount>
<committed_amount>0</committed_amount>
<conflicts>
<FinancialAidAllocationConflictResponse>
<application_start_term>String</application_start_term>
<award_code>String</award_code>
<award_description>String</award_description>
<fallback_application_uuid>String</fallback_application_uuid>
<fallback_status>String</fallback_status>
<fallback_student_name>String</fallback_student_name>
<primary_application_uuid>String</primary_application_uuid>
<primary_student_name>String</primary_student_name>
<reclaimable_amount>0</reclaimable_amount>
</FinancialAidAllocationConflictResponse>
</conflicts>
<incomplete_candidates>
<FinancialAidAllocationCandidateResponse>
<application_start_term>String</application_start_term>
<application_uuid>String</application_uuid>
<award_target>0</award_target>
<committed_amount>0</committed_amount>
<current_status>String</current_status>
<eligibility_tier>String</eligibility_tier>
<first_name>String</first_name>
<incomplete_reason>String</incomplete_reason>
<last_name>String</last_name>
<proposed_amount>0</proposed_amount>
<regent_id>0</regent_id>
<submitted_date>0001-01-01T00:00:00</submitted_date>
<unmet_amount>0</unmet_amount>
<uuid>String</uuid>
</FinancialAidAllocationCandidateResponse>
</incomplete_candidates>
<projected_unused_amount>0</projected_unused_amount>
<proposed_amount>0</proposed_amount>
<reporting_term>String</reporting_term>
</FinancialAidAllocationReviewResponse>