regis

FinancialAidAllocationReviewRequest

**Requires Authentication**
Required role:	REGISUserRole

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class FinancialAidAllocationReviewRequest
{
    var reporting_term:String? = null
    var authorizing_uuid:String? = null
}

open class FinancialAidAllocationReviewResponse
{
    var responseStatus:ResponseStatus? = null
    var reporting_term:String? = null
    var budget_amount:BigDecimal? = null
    var committed_amount:BigDecimal? = null
    var proposed_amount:BigDecimal? = null
    var projected_unused_amount:BigDecimal? = null
    var actionable_unmet_amount:BigDecimal? = null
    var awards:ArrayList<FinancialAidAllocationAwardResponse> = ArrayList<FinancialAidAllocationAwardResponse>()
    var incomplete_candidates:ArrayList<FinancialAidAllocationCandidateResponse> = ArrayList<FinancialAidAllocationCandidateResponse>()
    var conflicts:ArrayList<FinancialAidAllocationConflictResponse> = ArrayList<FinancialAidAllocationConflictResponse>()
}

open class FinancialAidAllocationAwardResponse
{
    var award_code:String? = null
    var award_description:String? = null
    var budget_amount:BigDecimal? = null
    var planned_or_offered_amount:BigDecimal? = null
    var accepted_or_issued_amount:BigDecimal? = null
    var committed_amount:BigDecimal? = null
    var reclaimable_amount:BigDecimal? = null
    var proposed_amount:BigDecimal? = null
    var projected_remaining_amount:BigDecimal? = null
    var must_award_whole_budget:Boolean? = null
    var requires_manual_review:Boolean? = null
    var manual_review_note:String? = null
    var required_recipient_count:Int? = null
    var requires_equal_shares:Boolean? = null
    var application_cycles:ArrayList<FinancialAidAllocationCycleResponse> = ArrayList<FinancialAidAllocationCycleResponse>()
    var proposals:ArrayList<FinancialAidAllocationProposalResponse> = ArrayList<FinancialAidAllocationProposalResponse>()
}

open class FinancialAidAllocationCycleResponse
{
    var application_start_term:String? = null
    var is_fallback_released:Boolean? = null
    var fallback_release_date:Date? = null
    var fallback_released_by:String? = null
    var primary_candidates:ArrayList<FinancialAidAllocationCandidateResponse> = ArrayList<FinancialAidAllocationCandidateResponse>()
    var fallback_candidates:ArrayList<FinancialAidAllocationCandidateResponse> = ArrayList<FinancialAidAllocationCandidateResponse>()
    var manual_review_candidates:ArrayList<FinancialAidAllocationCandidateResponse> = ArrayList<FinancialAidAllocationCandidateResponse>()
}

open class FinancialAidAllocationCandidateResponse
{
    var application_uuid:String? = null
    var uuid:String? = null
    var regent_id:Int? = null
    var first_name:String? = null
    var last_name:String? = null
    var application_start_term:String? = null
    var current_status:String? = null
    var submitted_date:Date? = null
    var eligibility_tier:String? = null
    var award_target:BigDecimal? = null
    var committed_amount:BigDecimal? = null
    var unmet_amount:BigDecimal? = null
    var proposed_amount:BigDecimal? = null
    var incomplete_reason:String? = null
}

open class FinancialAidAllocationProposalResponse
{
    var application_uuid:String? = null
    var regent_id:Int? = null
    var student_name:String? = null
    var application_start_term:String? = null
    var eligibility_tier:String? = null
    var amount:BigDecimal? = null
}

open class FinancialAidAllocationConflictResponse
{
    var award_code:String? = null
    var award_description:String? = null
    var application_start_term:String? = null
    var fallback_application_uuid:String? = null
    var fallback_student_name:String? = null
    var fallback_status:String? = null
    var reclaimable_amount:BigDecimal? = null
    var primary_application_uuid:String? = null
    var primary_student_name:String? = null
}

Kotlin FinancialAidAllocationReviewRequest DTOs

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

HTTP + 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"}]}