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
FinancialAidApplicationUpsertRequest Parameters:
NameParameterData TypeRequiredDescription
uuidbodystringNo
application_uuidpathstringNo
authorizing_uuidbodystringNo
citizenshipbodystringNo
citizenship_otherbodystringNo
permanent_residentbodystringNo
marital_statusbodystringNo
genderbodystringNo
denominationbodystringNo
ethnicitybodystringNo
programbodystringNo
start_termbodystringNo
end_termbodystringNo
number_of_termsbodyint?No
financial_assetsbodydecimal?No
spouse_incomebodydecimal?No
number_of_childrenbodyint?No
employment_yearsbodyint?No
employment_descriptionbodystringNo
vocational_experience_jsonbodystringNo
vocational_direction_jsonbodystringNo
occupation_after_the_program_jsonbodystringNo
area_of_study_jsonbodystringNo
undergrad_gpabodydecimal?No
regent_gpabodydecimal?No
is_maturebodyboolNo
is_nonaccreditedbodyboolNo
award_per_termbodydecimal?No
amount_awardedbodydecimal?No
need_scorebodyintNo
merit_scorebodyintNo
current_statusbodystringNo
commentsbodystringNo

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