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}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class FinancialAidAllocationReviewRequest
    {
        public virtual string reporting_term { get; set; }
        public virtual string authorizing_uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class FinancialAidAllocationAwardResponse
    {
        public FinancialAidAllocationAwardResponse()
        {
            application_cycles = new List<FinancialAidAllocationCycleResponse>{};
            proposals = new List<FinancialAidAllocationProposalResponse>{};
        }

        public virtual string award_code { get; set; }
        public virtual string award_description { get; set; }
        public virtual decimal budget_amount { get; set; }
        public virtual decimal planned_or_offered_amount { get; set; }
        public virtual decimal accepted_or_issued_amount { get; set; }
        public virtual decimal committed_amount { get; set; }
        public virtual decimal reclaimable_amount { get; set; }
        public virtual decimal proposed_amount { get; set; }
        public virtual decimal projected_remaining_amount { get; set; }
        public virtual bool must_award_whole_budget { get; set; }
        public virtual bool requires_manual_review { get; set; }
        public virtual string manual_review_note { get; set; }
        public virtual int? required_recipient_count { get; set; }
        public virtual bool requires_equal_shares { get; set; }
        public virtual List<FinancialAidAllocationCycleResponse> application_cycles { get; set; }
        public virtual List<FinancialAidAllocationProposalResponse> proposals { get; set; }
    }

    public partial class FinancialAidAllocationCandidateResponse
    {
        public virtual string application_uuid { get; set; }
        public virtual string uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string application_start_term { get; set; }
        public virtual string current_status { get; set; }
        public virtual DateTime? submitted_date { get; set; }
        public virtual string eligibility_tier { get; set; }
        public virtual decimal award_target { get; set; }
        public virtual decimal committed_amount { get; set; }
        public virtual decimal unmet_amount { get; set; }
        public virtual decimal proposed_amount { get; set; }
        public virtual string incomplete_reason { get; set; }
    }

    public partial class FinancialAidAllocationConflictResponse
    {
        public virtual string award_code { get; set; }
        public virtual string award_description { get; set; }
        public virtual string application_start_term { get; set; }
        public virtual string fallback_application_uuid { get; set; }
        public virtual string fallback_student_name { get; set; }
        public virtual string fallback_status { get; set; }
        public virtual decimal reclaimable_amount { get; set; }
        public virtual string primary_application_uuid { get; set; }
        public virtual string primary_student_name { get; set; }
    }

    public partial class FinancialAidAllocationCycleResponse
    {
        public FinancialAidAllocationCycleResponse()
        {
            primary_candidates = new List<FinancialAidAllocationCandidateResponse>{};
            fallback_candidates = new List<FinancialAidAllocationCandidateResponse>{};
            manual_review_candidates = new List<FinancialAidAllocationCandidateResponse>{};
        }

        public virtual string application_start_term { get; set; }
        public virtual bool is_fallback_released { get; set; }
        public virtual DateTime? fallback_release_date { get; set; }
        public virtual string fallback_released_by { get; set; }
        public virtual List<FinancialAidAllocationCandidateResponse> primary_candidates { get; set; }
        public virtual List<FinancialAidAllocationCandidateResponse> fallback_candidates { get; set; }
        public virtual List<FinancialAidAllocationCandidateResponse> manual_review_candidates { get; set; }
    }

    public partial class FinancialAidAllocationProposalResponse
    {
        public virtual string application_uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string student_name { get; set; }
        public virtual string application_start_term { get; set; }
        public virtual string eligibility_tier { get; set; }
        public virtual decimal amount { get; set; }
    }

    public partial class FinancialAidAllocationReviewResponse
    {
        public FinancialAidAllocationReviewResponse()
        {
            awards = new List<FinancialAidAllocationAwardResponse>{};
            incomplete_candidates = new List<FinancialAidAllocationCandidateResponse>{};
            conflicts = new List<FinancialAidAllocationConflictResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual decimal budget_amount { get; set; }
        public virtual decimal committed_amount { get; set; }
        public virtual decimal proposed_amount { get; set; }
        public virtual decimal projected_unused_amount { get; set; }
        public virtual decimal actionable_unmet_amount { get; set; }
        public virtual List<FinancialAidAllocationAwardResponse> awards { get; set; }
        public virtual List<FinancialAidAllocationCandidateResponse> incomplete_candidates { get; set; }
        public virtual List<FinancialAidAllocationConflictResponse> conflicts { get; set; }
    }

}

C# FinancialAidAllocationReviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

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