regis

<back to all web services

ProvisionalRegistrationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Provisional
ProvisionalRegistrationsRequest Parameters:
NameParameterData TypeRequiredDescription
reporting_termbodystringNo
authorizing_uuidbodystringNo
ProvisionalRegistrationsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
provisional_registrationsformList<ProvisionalRegistrationResponse>No
ProvisionalRegistrationResponse Parameters:
NameParameterData TypeRequiredDescription
uuidformstringNo
regent_idformint?No
student_nameformstringNo
emailformstringNo
section_uuidformstringNo
student_section_uuidformstringNo
course_nameformstringNo
section_codeformstringNo
titleformstringNo
termformstringNo
amountformdecimalNo
is_auditformboolNo
is_waitlistformboolNo
is_missing_requisitesformboolNo
is_other_restrictionformboolNo
documentsformList<RegistrationDocumentResponse>No
requested_dateformDateTimeNo
RegistrationDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
uuidformstringNo
regent_idformintNo
first_nameformstringNo
last_nameformstringNo
genderformstringNo
emailformstringNo
programformstringNo
concentrationformstringNo
section_uuidformstringNo
course_nameformstringNo
course_titleformstringNo
reporting_termformstringNo
document_codeformstringNo
document_jsonformstringNo
document_nameformstringNo
document_descriptionformstringNo
added_dateformDateTime?No
changed_dateformDateTime?No

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 /Registration/Provisional HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reporting_term: String,
	authorizing_uuid: String
}
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
		}
	},
	provisional_registrations: 
	[
		{
			uuid: String,
			regent_id: 0,
			student_name: String,
			email: String,
			section_uuid: String,
			student_section_uuid: String,
			course_name: String,
			section_code: String,
			title: String,
			term: String,
			amount: 0,
			is_audit: False,
			is_waitlist: False,
			is_missing_requisites: False,
			is_other_restriction: False,
			documents: 
			[
				{
					uuid: String,
					regent_id: 0,
					first_name: String,
					last_name: String,
					gender: String,
					email: String,
					program: String,
					concentration: String,
					section_uuid: String,
					course_name: String,
					course_title: String,
					reporting_term: String,
					document_code: String,
					document_json: String,
					document_name: String,
					document_description: String,
					added_date: 0001-01-01,
					changed_date: 0001-01-01
				}
			],
			requested_date: 0001-01-01
		}
	]
}