regis

FinancialAidAllocationReviewRequest

**Requires Authentication**
Required role:	REGISUserRole

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationCandidateResponse:
    application_uuid: Optional[str] = None
    uuid: Optional[str] = None
    regent_id: int = 0
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    application_start_term: Optional[str] = None
    current_status: Optional[str] = None
    submitted_date: Optional[datetime.datetime] = None
    eligibility_tier: Optional[str] = None
    award_target: Decimal = decimal.Decimal(0)
    committed_amount: Decimal = decimal.Decimal(0)
    unmet_amount: Decimal = decimal.Decimal(0)
    proposed_amount: Decimal = decimal.Decimal(0)
    incomplete_reason: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationCycleResponse:
    application_start_term: Optional[str] = None
    is_fallback_released: bool = False
    fallback_release_date: Optional[datetime.datetime] = None
    fallback_released_by: Optional[str] = None
    primary_candidates: Optional[List[FinancialAidAllocationCandidateResponse]] = None
    fallback_candidates: Optional[List[FinancialAidAllocationCandidateResponse]] = None
    manual_review_candidates: Optional[List[FinancialAidAllocationCandidateResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationProposalResponse:
    application_uuid: Optional[str] = None
    regent_id: int = 0
    student_name: Optional[str] = None
    application_start_term: Optional[str] = None
    eligibility_tier: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationAwardResponse:
    award_code: Optional[str] = None
    award_description: Optional[str] = None
    budget_amount: Decimal = decimal.Decimal(0)
    planned_or_offered_amount: Decimal = decimal.Decimal(0)
    accepted_or_issued_amount: Decimal = decimal.Decimal(0)
    committed_amount: Decimal = decimal.Decimal(0)
    reclaimable_amount: Decimal = decimal.Decimal(0)
    proposed_amount: Decimal = decimal.Decimal(0)
    projected_remaining_amount: Decimal = decimal.Decimal(0)
    must_award_whole_budget: bool = False
    requires_manual_review: bool = False
    manual_review_note: Optional[str] = None
    required_recipient_count: Optional[int] = None
    requires_equal_shares: bool = False
    application_cycles: Optional[List[FinancialAidAllocationCycleResponse]] = None
    proposals: Optional[List[FinancialAidAllocationProposalResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationConflictResponse:
    award_code: Optional[str] = None
    award_description: Optional[str] = None
    application_start_term: Optional[str] = None
    fallback_application_uuid: Optional[str] = None
    fallback_student_name: Optional[str] = None
    fallback_status: Optional[str] = None
    reclaimable_amount: Decimal = decimal.Decimal(0)
    primary_application_uuid: Optional[str] = None
    primary_student_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationReviewResponse:
    response_status: Optional[ResponseStatus] = None
    reporting_term: Optional[str] = None
    budget_amount: Decimal = decimal.Decimal(0)
    committed_amount: Decimal = decimal.Decimal(0)
    proposed_amount: Decimal = decimal.Decimal(0)
    projected_unused_amount: Decimal = decimal.Decimal(0)
    actionable_unmet_amount: Decimal = decimal.Decimal(0)
    awards: Optional[List[FinancialAidAllocationAwardResponse]] = None
    incomplete_candidates: Optional[List[FinancialAidAllocationCandidateResponse]] = None
    conflicts: Optional[List[FinancialAidAllocationConflictResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationReviewRequest:
    reporting_term: Optional[str] = None
    authorizing_uuid: Optional[str] = None

Python 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>