regis

<back to all web services

FinancialAidAllocationReviewRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/FinancialAid/AllocationReview/{reporting_term}
import Foundation
import ServiceStack

public class FinancialAidAllocationReviewRequest : Codable
{
    public var reporting_term:String
    public var authorizing_uuid:String

    required public init(){}
}

public class FinancialAidAllocationReviewResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var reporting_term:String
    public var budget_amount:Double
    public var committed_amount:Double
    public var proposed_amount:Double
    public var projected_unused_amount:Double
    public var actionable_unmet_amount:Double
    public var awards:[FinancialAidAllocationAwardResponse] = []
    public var incomplete_candidates:[FinancialAidAllocationCandidateResponse] = []
    public var conflicts:[FinancialAidAllocationConflictResponse] = []

    required public init(){}
}

public class FinancialAidAllocationAwardResponse : Codable
{
    public var award_code:String
    public var award_description:String
    public var budget_amount:Double
    public var planned_or_offered_amount:Double
    public var accepted_or_issued_amount:Double
    public var committed_amount:Double
    public var reclaimable_amount:Double
    public var proposed_amount:Double
    public var projected_remaining_amount:Double
    public var must_award_whole_budget:Bool
    public var requires_manual_review:Bool
    public var manual_review_note:String
    public var required_recipient_count:Int?
    public var requires_equal_shares:Bool
    public var application_cycles:[FinancialAidAllocationCycleResponse] = []
    public var proposals:[FinancialAidAllocationProposalResponse] = []

    required public init(){}
}

public class FinancialAidAllocationCycleResponse : Codable
{
    public var application_start_term:String
    public var is_fallback_released:Bool
    public var fallback_release_date:Date?
    public var fallback_released_by:String
    public var primary_candidates:[FinancialAidAllocationCandidateResponse] = []
    public var fallback_candidates:[FinancialAidAllocationCandidateResponse] = []
    public var manual_review_candidates:[FinancialAidAllocationCandidateResponse] = []

    required public init(){}
}

public class FinancialAidAllocationCandidateResponse : Codable
{
    public var application_uuid:String
    public var uuid:String
    public var regent_id:Int
    public var first_name:String
    public var last_name:String
    public var application_start_term:String
    public var current_status:String
    public var submitted_date:Date?
    public var eligibility_tier:String
    public var award_target:Double
    public var committed_amount:Double
    public var unmet_amount:Double
    public var proposed_amount:Double
    public var incomplete_reason:String

    required public init(){}
}

public class FinancialAidAllocationProposalResponse : Codable
{
    public var application_uuid:String
    public var regent_id:Int
    public var student_name:String
    public var application_start_term:String
    public var eligibility_tier:String
    public var amount:Double

    required public init(){}
}

public class FinancialAidAllocationConflictResponse : Codable
{
    public var award_code:String
    public var award_description:String
    public var application_start_term:String
    public var fallback_application_uuid:String
    public var fallback_student_name:String
    public var fallback_status:String
    public var reclaimable_amount:Double
    public var primary_application_uuid:String
    public var primary_student_name:String

    required public init(){}
}

Swift FinancialAidAllocationReviewRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

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