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.*;

public class dtos
{

    public static class FinancialAidAllocationReviewRequest
    {
        public String reporting_term = null;
        public String authorizing_uuid = null;
        
        public String getReportingTerm() { return reporting_term; }
        public FinancialAidAllocationReviewRequest setReportingTerm(String value) { this.reporting_term = value; return this; }
        public String getAuthorizingUuid() { return authorizing_uuid; }
        public FinancialAidAllocationReviewRequest setAuthorizingUuid(String value) { this.authorizing_uuid = value; return this; }
    }

    public static class FinancialAidAllocationReviewResponse
    {
        public ResponseStatus responseStatus = null;
        public String reporting_term = null;
        public BigDecimal budget_amount = null;
        public BigDecimal committed_amount = null;
        public BigDecimal proposed_amount = null;
        public BigDecimal projected_unused_amount = null;
        public BigDecimal actionable_unmet_amount = null;
        public ArrayList<FinancialAidAllocationAwardResponse> awards = null;
        public ArrayList<FinancialAidAllocationCandidateResponse> incomplete_candidates = null;
        public ArrayList<FinancialAidAllocationConflictResponse> conflicts = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public FinancialAidAllocationReviewResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public FinancialAidAllocationReviewResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
        public BigDecimal getBudgetAmount() { return budget_amount; }
        public FinancialAidAllocationReviewResponse setBudgetAmount(BigDecimal value) { this.budget_amount = value; return this; }
        public BigDecimal getCommittedAmount() { return committed_amount; }
        public FinancialAidAllocationReviewResponse setCommittedAmount(BigDecimal value) { this.committed_amount = value; return this; }
        public BigDecimal getProposedAmount() { return proposed_amount; }
        public FinancialAidAllocationReviewResponse setProposedAmount(BigDecimal value) { this.proposed_amount = value; return this; }
        public BigDecimal getProjectedUnusedAmount() { return projected_unused_amount; }
        public FinancialAidAllocationReviewResponse setProjectedUnusedAmount(BigDecimal value) { this.projected_unused_amount = value; return this; }
        public BigDecimal getActionableUnmetAmount() { return actionable_unmet_amount; }
        public FinancialAidAllocationReviewResponse setActionableUnmetAmount(BigDecimal value) { this.actionable_unmet_amount = value; return this; }
        public ArrayList<FinancialAidAllocationAwardResponse> getAwards() { return awards; }
        public FinancialAidAllocationReviewResponse setAwards(ArrayList<FinancialAidAllocationAwardResponse> value) { this.awards = value; return this; }
        public ArrayList<FinancialAidAllocationCandidateResponse> getIncompleteCandidates() { return incomplete_candidates; }
        public FinancialAidAllocationReviewResponse setIncompleteCandidates(ArrayList<FinancialAidAllocationCandidateResponse> value) { this.incomplete_candidates = value; return this; }
        public ArrayList<FinancialAidAllocationConflictResponse> getConflicts() { return conflicts; }
        public FinancialAidAllocationReviewResponse setConflicts(ArrayList<FinancialAidAllocationConflictResponse> value) { this.conflicts = value; return this; }
    }

    public static class FinancialAidAllocationAwardResponse
    {
        public String award_code = null;
        public String award_description = null;
        public BigDecimal budget_amount = null;
        public BigDecimal planned_or_offered_amount = null;
        public BigDecimal accepted_or_issued_amount = null;
        public BigDecimal committed_amount = null;
        public BigDecimal reclaimable_amount = null;
        public BigDecimal proposed_amount = null;
        public BigDecimal projected_remaining_amount = null;
        public Boolean must_award_whole_budget = null;
        public Boolean requires_manual_review = null;
        public String manual_review_note = null;
        public Integer required_recipient_count = null;
        public Boolean requires_equal_shares = null;
        public ArrayList<FinancialAidAllocationCycleResponse> application_cycles = null;
        public ArrayList<FinancialAidAllocationProposalResponse> proposals = null;
        
        public String getAwardCode() { return award_code; }
        public FinancialAidAllocationAwardResponse setAwardCode(String value) { this.award_code = value; return this; }
        public String getAwardDescription() { return award_description; }
        public FinancialAidAllocationAwardResponse setAwardDescription(String value) { this.award_description = value; return this; }
        public BigDecimal getBudgetAmount() { return budget_amount; }
        public FinancialAidAllocationAwardResponse setBudgetAmount(BigDecimal value) { this.budget_amount = value; return this; }
        public BigDecimal getPlannedOrOfferedAmount() { return planned_or_offered_amount; }
        public FinancialAidAllocationAwardResponse setPlannedOrOfferedAmount(BigDecimal value) { this.planned_or_offered_amount = value; return this; }
        public BigDecimal getAcceptedOrIssuedAmount() { return accepted_or_issued_amount; }
        public FinancialAidAllocationAwardResponse setAcceptedOrIssuedAmount(BigDecimal value) { this.accepted_or_issued_amount = value; return this; }
        public BigDecimal getCommittedAmount() { return committed_amount; }
        public FinancialAidAllocationAwardResponse setCommittedAmount(BigDecimal value) { this.committed_amount = value; return this; }
        public BigDecimal getReclaimableAmount() { return reclaimable_amount; }
        public FinancialAidAllocationAwardResponse setReclaimableAmount(BigDecimal value) { this.reclaimable_amount = value; return this; }
        public BigDecimal getProposedAmount() { return proposed_amount; }
        public FinancialAidAllocationAwardResponse setProposedAmount(BigDecimal value) { this.proposed_amount = value; return this; }
        public BigDecimal getProjectedRemainingAmount() { return projected_remaining_amount; }
        public FinancialAidAllocationAwardResponse setProjectedRemainingAmount(BigDecimal value) { this.projected_remaining_amount = value; return this; }
        public Boolean isMustAwardWholeBudget() { return must_award_whole_budget; }
        public FinancialAidAllocationAwardResponse setMustAwardWholeBudget(Boolean value) { this.must_award_whole_budget = value; return this; }
        public Boolean isRequiresManualReview() { return requires_manual_review; }
        public FinancialAidAllocationAwardResponse setRequiresManualReview(Boolean value) { this.requires_manual_review = value; return this; }
        public String getManualReviewNote() { return manual_review_note; }
        public FinancialAidAllocationAwardResponse setManualReviewNote(String value) { this.manual_review_note = value; return this; }
        public Integer getRequiredRecipientCount() { return required_recipient_count; }
        public FinancialAidAllocationAwardResponse setRequiredRecipientCount(Integer value) { this.required_recipient_count = value; return this; }
        public Boolean isRequiresEqualShares() { return requires_equal_shares; }
        public FinancialAidAllocationAwardResponse setRequiresEqualShares(Boolean value) { this.requires_equal_shares = value; return this; }
        public ArrayList<FinancialAidAllocationCycleResponse> getApplicationCycles() { return application_cycles; }
        public FinancialAidAllocationAwardResponse setApplicationCycles(ArrayList<FinancialAidAllocationCycleResponse> value) { this.application_cycles = value; return this; }
        public ArrayList<FinancialAidAllocationProposalResponse> getProposals() { return proposals; }
        public FinancialAidAllocationAwardResponse setProposals(ArrayList<FinancialAidAllocationProposalResponse> value) { this.proposals = value; return this; }
    }

    public static class FinancialAidAllocationCycleResponse
    {
        public String application_start_term = null;
        public Boolean is_fallback_released = null;
        public Date fallback_release_date = null;
        public String fallback_released_by = null;
        public ArrayList<FinancialAidAllocationCandidateResponse> primary_candidates = null;
        public ArrayList<FinancialAidAllocationCandidateResponse> fallback_candidates = null;
        public ArrayList<FinancialAidAllocationCandidateResponse> manual_review_candidates = null;
        
        public String getApplicationStartTerm() { return application_start_term; }
        public FinancialAidAllocationCycleResponse setApplicationStartTerm(String value) { this.application_start_term = value; return this; }
        public Boolean getIsFallbackReleased() { return is_fallback_released; }
        public FinancialAidAllocationCycleResponse setIsFallbackReleased(Boolean value) { this.is_fallback_released = value; return this; }
        public Date getFallbackReleaseDate() { return fallback_release_date; }
        public FinancialAidAllocationCycleResponse setFallbackReleaseDate(Date value) { this.fallback_release_date = value; return this; }
        public String getFallbackReleasedBy() { return fallback_released_by; }
        public FinancialAidAllocationCycleResponse setFallbackReleasedBy(String value) { this.fallback_released_by = value; return this; }
        public ArrayList<FinancialAidAllocationCandidateResponse> getPrimaryCandidates() { return primary_candidates; }
        public FinancialAidAllocationCycleResponse setPrimaryCandidates(ArrayList<FinancialAidAllocationCandidateResponse> value) { this.primary_candidates = value; return this; }
        public ArrayList<FinancialAidAllocationCandidateResponse> getFallbackCandidates() { return fallback_candidates; }
        public FinancialAidAllocationCycleResponse setFallbackCandidates(ArrayList<FinancialAidAllocationCandidateResponse> value) { this.fallback_candidates = value; return this; }
        public ArrayList<FinancialAidAllocationCandidateResponse> getManualReviewCandidates() { return manual_review_candidates; }
        public FinancialAidAllocationCycleResponse setManualReviewCandidates(ArrayList<FinancialAidAllocationCandidateResponse> value) { this.manual_review_candidates = value; return this; }
    }

    public static class FinancialAidAllocationCandidateResponse
    {
        public String application_uuid = null;
        public String uuid = null;
        public Integer regent_id = null;
        public String first_name = null;
        public String last_name = null;
        public String application_start_term = null;
        public String current_status = null;
        public Date submitted_date = null;
        public String eligibility_tier = null;
        public BigDecimal award_target = null;
        public BigDecimal committed_amount = null;
        public BigDecimal unmet_amount = null;
        public BigDecimal proposed_amount = null;
        public String incomplete_reason = null;
        
        public String getApplicationUuid() { return application_uuid; }
        public FinancialAidAllocationCandidateResponse setApplicationUuid(String value) { this.application_uuid = value; return this; }
        public String getUuid() { return uuid; }
        public FinancialAidAllocationCandidateResponse setUuid(String value) { this.uuid = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public FinancialAidAllocationCandidateResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getFirstName() { return first_name; }
        public FinancialAidAllocationCandidateResponse setFirstName(String value) { this.first_name = value; return this; }
        public String getLastName() { return last_name; }
        public FinancialAidAllocationCandidateResponse setLastName(String value) { this.last_name = value; return this; }
        public String getApplicationStartTerm() { return application_start_term; }
        public FinancialAidAllocationCandidateResponse setApplicationStartTerm(String value) { this.application_start_term = value; return this; }
        public String getCurrentStatus() { return current_status; }
        public FinancialAidAllocationCandidateResponse setCurrentStatus(String value) { this.current_status = value; return this; }
        public Date getSubmittedDate() { return submitted_date; }
        public FinancialAidAllocationCandidateResponse setSubmittedDate(Date value) { this.submitted_date = value; return this; }
        public String getEligibilityTier() { return eligibility_tier; }
        public FinancialAidAllocationCandidateResponse setEligibilityTier(String value) { this.eligibility_tier = value; return this; }
        public BigDecimal getAwardTarget() { return award_target; }
        public FinancialAidAllocationCandidateResponse setAwardTarget(BigDecimal value) { this.award_target = value; return this; }
        public BigDecimal getCommittedAmount() { return committed_amount; }
        public FinancialAidAllocationCandidateResponse setCommittedAmount(BigDecimal value) { this.committed_amount = value; return this; }
        public BigDecimal getUnmetAmount() { return unmet_amount; }
        public FinancialAidAllocationCandidateResponse setUnmetAmount(BigDecimal value) { this.unmet_amount = value; return this; }
        public BigDecimal getProposedAmount() { return proposed_amount; }
        public FinancialAidAllocationCandidateResponse setProposedAmount(BigDecimal value) { this.proposed_amount = value; return this; }
        public String getIncompleteReason() { return incomplete_reason; }
        public FinancialAidAllocationCandidateResponse setIncompleteReason(String value) { this.incomplete_reason = value; return this; }
    }

    public static class FinancialAidAllocationProposalResponse
    {
        public String application_uuid = null;
        public Integer regent_id = null;
        public String student_name = null;
        public String application_start_term = null;
        public String eligibility_tier = null;
        public BigDecimal amount = null;
        
        public String getApplicationUuid() { return application_uuid; }
        public FinancialAidAllocationProposalResponse setApplicationUuid(String value) { this.application_uuid = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public FinancialAidAllocationProposalResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getStudentName() { return student_name; }
        public FinancialAidAllocationProposalResponse setStudentName(String value) { this.student_name = value; return this; }
        public String getApplicationStartTerm() { return application_start_term; }
        public FinancialAidAllocationProposalResponse setApplicationStartTerm(String value) { this.application_start_term = value; return this; }
        public String getEligibilityTier() { return eligibility_tier; }
        public FinancialAidAllocationProposalResponse setEligibilityTier(String value) { this.eligibility_tier = value; return this; }
        public BigDecimal getAmount() { return amount; }
        public FinancialAidAllocationProposalResponse setAmount(BigDecimal value) { this.amount = value; return this; }
    }

    public static class FinancialAidAllocationConflictResponse
    {
        public String award_code = null;
        public String award_description = null;
        public String application_start_term = null;
        public String fallback_application_uuid = null;
        public String fallback_student_name = null;
        public String fallback_status = null;
        public BigDecimal reclaimable_amount = null;
        public String primary_application_uuid = null;
        public String primary_student_name = null;
        
        public String getAwardCode() { return award_code; }
        public FinancialAidAllocationConflictResponse setAwardCode(String value) { this.award_code = value; return this; }
        public String getAwardDescription() { return award_description; }
        public FinancialAidAllocationConflictResponse setAwardDescription(String value) { this.award_description = value; return this; }
        public String getApplicationStartTerm() { return application_start_term; }
        public FinancialAidAllocationConflictResponse setApplicationStartTerm(String value) { this.application_start_term = value; return this; }
        public String getFallbackApplicationUuid() { return fallback_application_uuid; }
        public FinancialAidAllocationConflictResponse setFallbackApplicationUuid(String value) { this.fallback_application_uuid = value; return this; }
        public String getFallbackStudentName() { return fallback_student_name; }
        public FinancialAidAllocationConflictResponse setFallbackStudentName(String value) { this.fallback_student_name = value; return this; }
        public String getFallbackStatus() { return fallback_status; }
        public FinancialAidAllocationConflictResponse setFallbackStatus(String value) { this.fallback_status = value; return this; }
        public BigDecimal getReclaimableAmount() { return reclaimable_amount; }
        public FinancialAidAllocationConflictResponse setReclaimableAmount(BigDecimal value) { this.reclaimable_amount = value; return this; }
        public String getPrimaryApplicationUuid() { return primary_application_uuid; }
        public FinancialAidAllocationConflictResponse setPrimaryApplicationUuid(String value) { this.primary_application_uuid = value; return this; }
        public String getPrimaryStudentName() { return primary_student_name; }
        public FinancialAidAllocationConflictResponse setPrimaryStudentName(String value) { this.primary_student_name = value; return this; }
    }

}

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