regis

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 .xml suffix or ?format=xml

HTTP + 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>