regis

<back to all web services

StudentGraduationRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentGraduation/{uuid}/{year}
StudentGraduationRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
yearpathintNo
StudentGraduationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
first_nameformstringNo
preferred_nameformstringNo
middle_nameformstringNo
last_nameformstringNo
emailformstringNo
phonetic_first_nameformstringNo
phonetic_middle_nameformstringNo
phonetic_last_nameformstringNo
placementformstringNo
placement_otherformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
citizenshipformstringNo
citizenship_otherformstringNo
permanent_residentformstringNo
previous_degreesformstringNo
gown_sizeformint?No
project_titleformstringNo
supervisorformstringNo
is_attendingformboolNo
is_hood_requestedformboolNo
is_hood_paidformboolNo
is_paidformboolNo
is_lateformboolNo
yearformint?No
commentsformstringNo
current_statusformstringNo
current_status_dateformDateTime?No
added_dateformDateTime?No
applied_programsformList<StudentGraduationProgramResponse>No
StudentGraduationProgramResponse Parameters:
NameParameterData TypeRequiredDescription
program_codeformstringNo
concentration_codeformstringNo
program_detailsformstringNo
commentsformstringNo

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 /StudentGraduation/{uuid}/{year} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	year: 0
}
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
		}
	},
	regent_id: 0,
	uuid: String,
	first_name: String,
	preferred_name: String,
	middle_name: String,
	last_name: String,
	email: String,
	phonetic_first_name: String,
	phonetic_middle_name: String,
	phonetic_last_name: String,
	placement: String,
	placement_other: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	citizenship: String,
	citizenship_other: String,
	permanent_resident: String,
	previous_degrees: String,
	gown_size: 0,
	project_title: String,
	supervisor: String,
	is_attending: False,
	is_hood_requested: False,
	is_hood_paid: False,
	is_paid: False,
	is_late: False,
	year: 0,
	comments: String,
	current_status: String,
	current_status_date: 0001-01-01,
	added_date: 0001-01-01,
	applied_programs: 
	[
		{
			program_code: String,
			concentration_code: String,
			program_details: String,
			comments: String
		}
	]
}