regis

FinancialAidAllocationReviewRequest

**Requires Authentication**
Required role:	REGISUserRole

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

"use strict";
export class FinancialAidAllocationCandidateResponse {
    /** @param {{application_uuid?:string,uuid?:string,regent_id?:number,first_name?:string,last_name?:string,application_start_term?:string,current_status?:string,submitted_date?:string,eligibility_tier?:string,award_target?:number,committed_amount?:number,unmet_amount?:number,proposed_amount?:number,incomplete_reason?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    application_uuid;
    /** @type {string} */
    uuid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    application_start_term;
    /** @type {string} */
    current_status;
    /** @type {?string} */
    submitted_date;
    /** @type {string} */
    eligibility_tier;
    /** @type {number} */
    award_target;
    /** @type {number} */
    committed_amount;
    /** @type {number} */
    unmet_amount;
    /** @type {number} */
    proposed_amount;
    /** @type {string} */
    incomplete_reason;
}
export class FinancialAidAllocationCycleResponse {
    /** @param {{application_start_term?:string,is_fallback_released?:boolean,fallback_release_date?:string,fallback_released_by?:string,primary_candidates?:FinancialAidAllocationCandidateResponse[],fallback_candidates?:FinancialAidAllocationCandidateResponse[],manual_review_candidates?:FinancialAidAllocationCandidateResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    application_start_term;
    /** @type {boolean} */
    is_fallback_released;
    /** @type {?string} */
    fallback_release_date;
    /** @type {string} */
    fallback_released_by;
    /** @type {FinancialAidAllocationCandidateResponse[]} */
    primary_candidates;
    /** @type {FinancialAidAllocationCandidateResponse[]} */
    fallback_candidates;
    /** @type {FinancialAidAllocationCandidateResponse[]} */
    manual_review_candidates;
}
export class FinancialAidAllocationProposalResponse {
    /** @param {{application_uuid?:string,regent_id?:number,student_name?:string,application_start_term?:string,eligibility_tier?:string,amount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    application_uuid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    student_name;
    /** @type {string} */
    application_start_term;
    /** @type {string} */
    eligibility_tier;
    /** @type {number} */
    amount;
}
export class FinancialAidAllocationAwardResponse {
    /** @param {{award_code?:string,award_description?:string,budget_amount?:number,planned_or_offered_amount?:number,accepted_or_issued_amount?:number,committed_amount?:number,reclaimable_amount?:number,proposed_amount?:number,projected_remaining_amount?:number,must_award_whole_budget?:boolean,requires_manual_review?:boolean,manual_review_note?:string,required_recipient_count?:number,requires_equal_shares?:boolean,application_cycles?:FinancialAidAllocationCycleResponse[],proposals?:FinancialAidAllocationProposalResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    award_code;
    /** @type {string} */
    award_description;
    /** @type {number} */
    budget_amount;
    /** @type {number} */
    planned_or_offered_amount;
    /** @type {number} */
    accepted_or_issued_amount;
    /** @type {number} */
    committed_amount;
    /** @type {number} */
    reclaimable_amount;
    /** @type {number} */
    proposed_amount;
    /** @type {number} */
    projected_remaining_amount;
    /** @type {boolean} */
    must_award_whole_budget;
    /** @type {boolean} */
    requires_manual_review;
    /** @type {string} */
    manual_review_note;
    /** @type {?number} */
    required_recipient_count;
    /** @type {boolean} */
    requires_equal_shares;
    /** @type {FinancialAidAllocationCycleResponse[]} */
    application_cycles;
    /** @type {FinancialAidAllocationProposalResponse[]} */
    proposals;
}
export class FinancialAidAllocationConflictResponse {
    /** @param {{award_code?:string,award_description?:string,application_start_term?:string,fallback_application_uuid?:string,fallback_student_name?:string,fallback_status?:string,reclaimable_amount?:number,primary_application_uuid?:string,primary_student_name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    award_code;
    /** @type {string} */
    award_description;
    /** @type {string} */
    application_start_term;
    /** @type {string} */
    fallback_application_uuid;
    /** @type {string} */
    fallback_student_name;
    /** @type {string} */
    fallback_status;
    /** @type {number} */
    reclaimable_amount;
    /** @type {string} */
    primary_application_uuid;
    /** @type {string} */
    primary_student_name;
}
export class FinancialAidAllocationReviewResponse {
    /** @param {{responseStatus?:ResponseStatus,reporting_term?:string,budget_amount?:number,committed_amount?:number,proposed_amount?:number,projected_unused_amount?:number,actionable_unmet_amount?:number,awards?:FinancialAidAllocationAwardResponse[],incomplete_candidates?:FinancialAidAllocationCandidateResponse[],conflicts?:FinancialAidAllocationConflictResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    reporting_term;
    /** @type {number} */
    budget_amount;
    /** @type {number} */
    committed_amount;
    /** @type {number} */
    proposed_amount;
    /** @type {number} */
    projected_unused_amount;
    /** @type {number} */
    actionable_unmet_amount;
    /** @type {FinancialAidAllocationAwardResponse[]} */
    awards;
    /** @type {FinancialAidAllocationCandidateResponse[]} */
    incomplete_candidates;
    /** @type {FinancialAidAllocationConflictResponse[]} */
    conflicts;
}
export class FinancialAidAllocationReviewRequest {
    /** @param {{reporting_term?:string,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    authorizing_uuid;
}

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