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}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class FinancialAidAllocationReviewRequest
            Public Overridable Property reporting_term As String
            Public Overridable Property authorizing_uuid As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class FinancialAidAllocationAwardResponse
            Public Sub New()
                application_cycles = New List(Of FinancialAidAllocationCycleResponse)
                proposals = New List(Of FinancialAidAllocationProposalResponse)
            End Sub

            Public Overridable Property award_code As String
            Public Overridable Property award_description As String
            Public Overridable Property budget_amount As Decimal
            Public Overridable Property planned_or_offered_amount As Decimal
            Public Overridable Property accepted_or_issued_amount As Decimal
            Public Overridable Property committed_amount As Decimal
            Public Overridable Property reclaimable_amount As Decimal
            Public Overridable Property proposed_amount As Decimal
            Public Overridable Property projected_remaining_amount As Decimal
            Public Overridable Property must_award_whole_budget As Boolean
            Public Overridable Property requires_manual_review As Boolean
            Public Overridable Property manual_review_note As String
            Public Overridable Property required_recipient_count As Nullable(Of Integer)
            Public Overridable Property requires_equal_shares As Boolean
            Public Overridable Property application_cycles As List(Of FinancialAidAllocationCycleResponse)
            Public Overridable Property proposals As List(Of FinancialAidAllocationProposalResponse)
        End Class

        Public Partial Class FinancialAidAllocationCandidateResponse
            Public Overridable Property application_uuid As String
            Public Overridable Property uuid As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property first_name As String
            Public Overridable Property last_name As String
            Public Overridable Property application_start_term As String
            Public Overridable Property current_status As String
            Public Overridable Property submitted_date As Nullable(Of Date)
            Public Overridable Property eligibility_tier As String
            Public Overridable Property award_target As Decimal
            Public Overridable Property committed_amount As Decimal
            Public Overridable Property unmet_amount As Decimal
            Public Overridable Property proposed_amount As Decimal
            Public Overridable Property incomplete_reason As String
        End Class

        Public Partial Class FinancialAidAllocationConflictResponse
            Public Overridable Property award_code As String
            Public Overridable Property award_description As String
            Public Overridable Property application_start_term As String
            Public Overridable Property fallback_application_uuid As String
            Public Overridable Property fallback_student_name As String
            Public Overridable Property fallback_status As String
            Public Overridable Property reclaimable_amount As Decimal
            Public Overridable Property primary_application_uuid As String
            Public Overridable Property primary_student_name As String
        End Class

        Public Partial Class FinancialAidAllocationCycleResponse
            Public Sub New()
                primary_candidates = New List(Of FinancialAidAllocationCandidateResponse)
                fallback_candidates = New List(Of FinancialAidAllocationCandidateResponse)
                manual_review_candidates = New List(Of FinancialAidAllocationCandidateResponse)
            End Sub

            Public Overridable Property application_start_term As String
            Public Overridable Property is_fallback_released As Boolean
            Public Overridable Property fallback_release_date As Nullable(Of Date)
            Public Overridable Property fallback_released_by As String
            Public Overridable Property primary_candidates As List(Of FinancialAidAllocationCandidateResponse)
            Public Overridable Property fallback_candidates As List(Of FinancialAidAllocationCandidateResponse)
            Public Overridable Property manual_review_candidates As List(Of FinancialAidAllocationCandidateResponse)
        End Class

        Public Partial Class FinancialAidAllocationProposalResponse
            Public Overridable Property application_uuid As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property student_name As String
            Public Overridable Property application_start_term As String
            Public Overridable Property eligibility_tier As String
            Public Overridable Property amount As Decimal
        End Class

        Public Partial Class FinancialAidAllocationReviewResponse
            Public Sub New()
                awards = New List(Of FinancialAidAllocationAwardResponse)
                incomplete_candidates = New List(Of FinancialAidAllocationCandidateResponse)
                conflicts = New List(Of FinancialAidAllocationConflictResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property reporting_term As String
            Public Overridable Property budget_amount As Decimal
            Public Overridable Property committed_amount As Decimal
            Public Overridable Property proposed_amount As Decimal
            Public Overridable Property projected_unused_amount As Decimal
            Public Overridable Property actionable_unmet_amount As Decimal
            Public Overridable Property awards As List(Of FinancialAidAllocationAwardResponse)
            Public Overridable Property incomplete_candidates As List(Of FinancialAidAllocationCandidateResponse)
            Public Overridable Property conflicts As List(Of FinancialAidAllocationConflictResponse)
        End Class
    End Namespace
End Namespace

VB.NET FinancialAidAllocationReviewRequest DTOs

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