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}
"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 .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"reporting_term":"String","authorizing_uuid":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}