regis

<back to all web services

FinancialAidApplicationRequest

Requires Authentication
Required permission:FinancialAidPermission
The following routes are available for this service:
POST/Finance/FinancialAid/Application/{application_uuid}/Get
POST/Finance/FinancialAid/{uuid}/Application/{start_term}
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FinancialAidApplicationAwardResponse() = 
        member val id:Int32 = new Int32() with get,set
        member val award_code:String = null with get,set
        member val award_description:String = null with get,set
        member val is_awarded:Boolean = new Boolean() with get,set
        member val is_planned:Boolean = new Boolean() with get,set
        member val is_eligible:Boolean = new Boolean() with get,set
        member val award_amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val award_budget:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val comments:String = null with get,set
        member val term:String = null with get,set
        member val awarded_by:String = null with get,set
        member val awarded_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type FinancialAidApplicationResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val start_term:String = null with get,set
        member val end_term:String = null with get,set
        member val number_of_terms:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val application_uuid:String = null with get,set
        member val awards:ResizeArray<FinancialAidApplicationAwardResponse> = new ResizeArray<FinancialAidApplicationAwardResponse>() with get,set
        member val previous_awards:ResizeArray<FinancialAidApplicationAwardResponse> = new ResizeArray<FinancialAidApplicationAwardResponse>() with get,set
        member val program:String = null with get,set
        member val gender:String = null with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val email:String = null with get,set
        member val citizenship:String = null with get,set
        member val citizenship_other:String = null with get,set
        member val permanent_resident:String = null with get,set
        member val ethnicity:String = null with get,set
        member val marital_status:String = null with get,set
        member val dob:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val addr1:String = null with get,set
        member val addr2:String = null with get,set
        member val city:String = null with get,set
        member val state:String = null with get,set
        member val country:String = null with get,set
        member val code:String = null with get,set
        member val denomination:String = null with get,set
        member val undergrad_gpa:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val regent_gpa:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val current_attempted_credits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val first_term_admitted:String = null with get,set
        member val current_attempted_and_transferred_credits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val current_award_term_attempted_credits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val number_of_children:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val financial_assets:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val spouse_income:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val employment_years:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val employment_description:String = null with get,set
        member val vocational_experience_json:String = null with get,set
        member val vocational_direction_json:String = null with get,set
        member val occupation_after_the_program_json:String = null with get,set
        member val area_of_study_json:String = null with get,set
        member val need_score:Int32 = new Int32() with get,set
        member val merit_score:Int32 = new Int32() with get,set
        member val score:Int32 = new Int32() with get,set
        member val is_mature:Boolean = new Boolean() with get,set
        member val is_nonaccredited:Boolean = new Boolean() with get,set
        member val award_per_term:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val amount_awarded:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val oncampus_tuition_owing_in_term:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val online_tuition_owing_in_term:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val audit_and_fees_owing_in_term:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val amount_offered:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val total_amount_awarded:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val comments:String = null with get,set
        member val current_status:String = null with get,set
        member val cannot_apply_again:Boolean = new Boolean() with get,set
        member val current_status_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val started_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val started_by:String = null with get,set
        member val submitted_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val submitted_by:String = null with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_by:String = null with get,set

    [<AllowNullLiteral>]
    type FinancialAidApplicationRequest() = 
        member val uuid:String = null with get,set
        member val start_term:String = null with get,set
        member val application_uuid:String = null with get,set
        member val awards_in_term:String = null with get,set
        member val no_awards_in_response:Boolean = new Boolean() with get,set

F# FinancialAidApplicationRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/FinancialAid/Application/{application_uuid}/Get HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String","start_term":"String","application_uuid":"String","awards_in_term":"String","no_awards_in_response":false}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"start_term":"String","end_term":"String","number_of_terms":0,"regent_id":0,"uuid":"String","application_uuid":"String","awards":[{"id":0,"award_code":"String","award_description":"String","is_awarded":false,"is_planned":false,"is_eligible":false,"award_amount":0,"award_budget":0,"comments":"String","term":"String","awarded_by":"String","awarded_date":"0001-01-01T00:00:00.0000000"}],"previous_awards":[{"id":0,"award_code":"String","award_description":"String","is_awarded":false,"is_planned":false,"is_eligible":false,"award_amount":0,"award_budget":0,"comments":"String","term":"String","awarded_by":"String","awarded_date":"0001-01-01T00:00:00.0000000"}],"program":"String","gender":"String","first_name":"String","last_name":"String","email":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","ethnicity":"String","marital_status":"String","dob":"0001-01-01T00:00:00.0000000","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","denomination":"String","undergrad_gpa":0,"regent_gpa":0,"current_attempted_credits":0,"first_term_admitted":"String","current_attempted_and_transferred_credits":0,"current_award_term_attempted_credits":0,"number_of_children":0,"financial_assets":0,"spouse_income":0,"employment_years":0,"employment_description":"String","vocational_experience_json":"String","vocational_direction_json":"String","occupation_after_the_program_json":"String","area_of_study_json":"String","need_score":0,"merit_score":0,"score":0,"is_mature":false,"is_nonaccredited":false,"award_per_term":0,"amount_awarded":0,"oncampus_tuition_owing_in_term":0,"online_tuition_owing_in_term":0,"audit_and_fees_owing_in_term":0,"amount_offered":0,"total_amount_awarded":0,"comments":"String","current_status":"String","cannot_apply_again":false,"current_status_date":"0001-01-01T00:00:00.0000000","started_date":"0001-01-01T00:00:00.0000000","started_by":"String","submitted_date":"0001-01-01T00:00:00.0000000","submitted_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String"}