regis

<back to all web services

FinancialAidApplicationUpsertRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/FinancialAid/Application/Upsert/New
POST/Finance/FinancialAid/Application/{application_uuid}/Upsert
namespace regis.ClassLibrary.Requests

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

    [<AllowNullLiteral>]
    type FinancialAidApplicationUpsertRequest() = 
        member val uuid:String = null with get,set
        member val application_uuid:String = null with get,set
        member val authorizing_uuid: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 marital_status:String = null with get,set
        member val gender:String = null with get,set
        member val denomination:String = null with get,set
        member val ethnicity:String = null with get,set
        member val program:String = 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 financial_assets:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val spouse_income:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val number_of_children:Nullable<Int32> = new Nullable<Int32>() 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 undergrad_gpa:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val regent_gpa:Nullable<Decimal> = new Nullable<Decimal>() 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 need_score:Int32 = new Int32() with get,set
        member val merit_score:Int32 = new Int32() with get,set
        member val current_status:String = null with get,set
        member val comments:String = null with get,set

F# FinancialAidApplicationUpsertRequest DTOs

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

HTTP + JSV

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

POST /Finance/FinancialAid/Application/Upsert/New HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	application_uuid: String,
	authorizing_uuid: String,
	citizenship: String,
	citizenship_other: String,
	permanent_resident: String,
	marital_status: String,
	gender: String,
	denomination: String,
	ethnicity: String,
	program: String,
	start_term: String,
	end_term: String,
	number_of_terms: 0,
	financial_assets: 0,
	spouse_income: 0,
	number_of_children: 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,
	undergrad_gpa: 0,
	regent_gpa: 0,
	is_mature: False,
	is_nonaccredited: False,
	award_per_term: 0,
	amount_awarded: 0,
	need_score: 0,
	merit_score: 0,
	current_status: String,
	comments: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}