regis

<back to all web services

FinancialAidApplicationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/FinancialAid/Applications
import java.math.*
import java.util.*
import net.servicestack.client.*


open class FinancialAidApplicationsRequest
{
    var start_term:String? = null
    var continuing_term:String? = null
    var issued_in_term:String? = null
    var available_in_term:String? = null
    var done_in_term:String? = null
    var no_awards_in_response:Boolean? = null
}

open class FinancialAidApplicationsResponse
{
    var responseStatus:ResponseStatus? = null
    var applications:ArrayList<FinancialAidApplicationResponse> = ArrayList<FinancialAidApplicationResponse>()
}

open class FinancialAidApplicationResponse
{
    var responseStatus:ResponseStatus? = null
    var start_term:String? = null
    var end_term:String? = null
    var number_of_terms:Int? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var application_uuid:String? = null
    var awards:ArrayList<FinancialAidApplicationAwardResponse> = ArrayList<FinancialAidApplicationAwardResponse>()
    var previous_awards:ArrayList<FinancialAidApplicationAwardResponse> = ArrayList<FinancialAidApplicationAwardResponse>()
    var program:String? = null
    var gender:String? = null
    var first_name:String? = null
    var last_name:String? = null
    var email:String? = null
    var citizenship:String? = null
    var citizenship_other:String? = null
    var permanent_resident:String? = null
    var ethnicity:String? = null
    var marital_status:String? = null
    var dob:Date? = null
    var addr1:String? = null
    var addr2:String? = null
    var city:String? = null
    var state:String? = null
    var country:String? = null
    var code:String? = null
    var denomination:String? = null
    var undergrad_gpa:BigDecimal? = null
    var regent_gpa:BigDecimal? = null
    var current_attempted_credits:BigDecimal? = null
    var first_term_admitted:String? = null
    var current_attempted_and_transferred_credits:BigDecimal? = null
    var current_award_term_attempted_credits:BigDecimal? = null
    var number_of_children:Int? = null
    var financial_assets:BigDecimal? = null
    var spouse_income:BigDecimal? = null
    var employment_years:Int? = null
    var employment_description:String? = null
    var vocational_experience_json:String? = null
    var vocational_direction_json:String? = null
    var occupation_after_the_program_json:String? = null
    var area_of_study_json:String? = null
    var need_score:Int? = null
    var merit_score:Int? = null
    var score:Int? = null
    var is_mature:Boolean? = null
    var is_nonaccredited:Boolean? = null
    var award_per_term:BigDecimal? = null
    var amount_awarded:BigDecimal? = null
    var oncampus_tuition_owing_in_term:BigDecimal? = null
    var online_tuition_owing_in_term:BigDecimal? = null
    var audit_and_fees_owing_in_term:BigDecimal? = null
    var amount_offered:BigDecimal? = null
    var total_amount_awarded:BigDecimal? = null
    var comments:String? = null
    var current_status:String? = null
    var cannot_apply_again:Boolean? = null
    var current_status_date:Date? = null
    var started_date:Date? = null
    var started_by:String? = null
    var submitted_date:Date? = null
    var submitted_by:String? = null
    var changed_date:Date? = null
    var changed_by:String? = null
}

open class FinancialAidApplicationAwardResponse
{
    var id:Int? = null
    var award_code:String? = null
    var award_description:String? = null
    var is_awarded:Boolean? = null
    var is_planned:Boolean? = null
    var is_eligible:Boolean? = null
    var award_amount:BigDecimal? = null
    var award_budget:BigDecimal? = null
    var comments:String? = null
    var term:String? = null
    var awarded_by:String? = null
    var awarded_date:Date? = null
}

Kotlin FinancialAidApplicationsRequest 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/Applications HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"start_term":"String","continuing_term":"String","issued_in_term":"String","available_in_term":"String","done_in_term":"String","no_awards_in_response":false}
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"}},"applications":[{"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"}]}