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

export class FinancialAidApplicationUpsertRequest
{
    public uuid: string;
    public application_uuid: string;
    public authorizing_uuid: string;
    public citizenship: string;
    public citizenship_other: string;
    public permanent_resident: string;
    public marital_status: string;
    public gender: string;
    public denomination: string;
    public ethnicity: string;
    public program: string;
    public start_term: string;
    public end_term: string;
    public number_of_terms?: number;
    public financial_assets?: number;
    public spouse_income?: number;
    public number_of_children?: number;
    public employment_years?: number;
    public employment_description: string;
    public vocational_experience_json: string;
    public vocational_direction_json: string;
    public occupation_after_the_program_json: string;
    public area_of_study_json: string;
    public undergrad_gpa?: number;
    public regent_gpa?: number;
    public is_mature: boolean;
    public is_nonaccredited: boolean;
    public award_per_term?: number;
    public amount_awarded?: number;
    public need_score: number;
    public merit_score: number;
    public current_status: string;
    public comments: string;

    public constructor(init?: Partial<FinancialAidApplicationUpsertRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
	}
}