| Required role: | REGISUserRole |
| POST | /Finance/FinancialAid/Applications |
|---|
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 FinancialAidApplicationsRequest
{
public virtual string start_term { get; set; }
public virtual string continuing_term { get; set; }
public virtual string issued_in_term { get; set; }
public virtual string available_in_term { get; set; }
public virtual string done_in_term { get; set; }
public virtual bool no_awards_in_response { get; set; }
}
}
namespace regis.ClassLibrary.Responses
{
public partial class FinancialAidApplicationAwardResponse
{
public virtual int id { get; set; }
public virtual string award_code { get; set; }
public virtual string award_description { get; set; }
public virtual bool is_awarded { get; set; }
public virtual bool is_planned { get; set; }
public virtual bool is_eligible { get; set; }
public virtual decimal? award_amount { get; set; }
public virtual decimal? award_budget { get; set; }
public virtual string comments { get; set; }
public virtual string term { get; set; }
public virtual string awarded_by { get; set; }
public virtual DateTime? awarded_date { get; set; }
}
public partial class FinancialAidApplicationResponse
{
public FinancialAidApplicationResponse()
{
awards = new List<FinancialAidApplicationAwardResponse>{};
previous_awards = new List<FinancialAidApplicationAwardResponse>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual string start_term { get; set; }
public virtual string end_term { get; set; }
public virtual int? number_of_terms { get; set; }
public virtual int regent_id { get; set; }
public virtual string uuid { get; set; }
public virtual string application_uuid { get; set; }
public virtual List<FinancialAidApplicationAwardResponse> awards { get; set; }
public virtual List<FinancialAidApplicationAwardResponse> previous_awards { get; set; }
public virtual string program { get; set; }
public virtual string gender { get; set; }
public virtual string first_name { get; set; }
public virtual string last_name { get; set; }
public virtual string email { get; set; }
public virtual string citizenship { get; set; }
public virtual string citizenship_other { get; set; }
public virtual string permanent_resident { get; set; }
public virtual string ethnicity { get; set; }
public virtual string marital_status { get; set; }
public virtual DateTime? dob { get; set; }
public virtual string addr1 { get; set; }
public virtual string addr2 { get; set; }
public virtual string city { get; set; }
public virtual string state { get; set; }
public virtual string country { get; set; }
public virtual string code { get; set; }
public virtual string denomination { get; set; }
public virtual decimal? undergrad_gpa { get; set; }
public virtual decimal? regent_gpa { get; set; }
public virtual decimal? current_attempted_credits { get; set; }
public virtual string first_term_admitted { get; set; }
public virtual decimal? current_attempted_and_transferred_credits { get; set; }
public virtual decimal? current_award_term_attempted_credits { get; set; }
public virtual int? number_of_children { get; set; }
public virtual decimal? financial_assets { get; set; }
public virtual decimal? spouse_income { get; set; }
public virtual int? employment_years { get; set; }
public virtual string employment_description { get; set; }
public virtual string vocational_experience_json { get; set; }
public virtual string vocational_direction_json { get; set; }
public virtual string occupation_after_the_program_json { get; set; }
public virtual string area_of_study_json { get; set; }
public virtual int need_score { get; set; }
public virtual int merit_score { get; set; }
public virtual int score { get; set; }
public virtual bool is_mature { get; set; }
public virtual bool is_nonaccredited { get; set; }
public virtual decimal? award_per_term { get; set; }
public virtual decimal? amount_awarded { get; set; }
public virtual decimal? oncampus_tuition_owing_in_term { get; set; }
public virtual decimal? online_tuition_owing_in_term { get; set; }
public virtual decimal? audit_and_fees_owing_in_term { get; set; }
public virtual decimal? amount_offered { get; set; }
public virtual decimal? total_amount_awarded { get; set; }
public virtual string comments { get; set; }
public virtual string current_status { get; set; }
public virtual bool cannot_apply_again { get; set; }
public virtual DateTime? current_status_date { get; set; }
public virtual DateTime? started_date { get; set; }
public virtual string started_by { get; set; }
public virtual DateTime? submitted_date { get; set; }
public virtual string submitted_by { get; set; }
public virtual DateTime? changed_date { get; set; }
public virtual string changed_by { get; set; }
}
public partial class FinancialAidApplicationsResponse
{
public FinancialAidApplicationsResponse()
{
applications = new List<FinancialAidApplicationResponse>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<FinancialAidApplicationResponse> applications { get; set; }
}
}
C# FinancialAidApplicationsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
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: text/jsv
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-01
}
],
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-01
}
],
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-01,
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-01,
started_date: 0001-01-01,
started_by: String,
submitted_date: 0001-01-01,
submitted_by: String,
changed_date: 0001-01-01,
changed_by: String
}
]
}