regis

<back to all web services

UnauthenticatedRegistrationTransactionRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Unauthenticated/{reporting_term}/{transaction_uuid}
UnauthenticatedRegistrationTransactionRequest Parameters:
NameParameterData TypeRequiredDescription
reporting_termpathstringNo
transaction_uuidpathstringNo
authorizing_uuidbodystringNo
UnauthenticatedRegistrationTransactionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
transaction_uuidformstringNo
notes_jsonformstringNo
credit_hoursformdecimalNo
audit_hoursformdecimalNo
started_datetimeformDateTimeNo
archived_datetimeformDateTime?No
submitted_datetimeformDateTime?No
authorized_datetimeformDateTime?No
personformUnauthenticatedPersonResponseNo
registrationsformList<UnauthenticatedStudentSectionRegistrationResponse>No
UnauthenticatedPersonResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformint?No
reporting_termformstringNo
surveyformstringNo
friend_referralformstringNo
other_referralformstringNo
is_returningformboolNo
is_applyingformboolNo
is_landlordformboolNo
postsecondary_education_levelformintNo
uuidformstringNo
regent_loginformstringNo
first_nameformstringNo
middle_nameformstringNo
last_nameformstringNo
preferred_nameformstringNo
birth_nameformstringNo
spouse_nameformstringNo
addr1formstringNo
addr2formstringNo
countryformstringNo
stateformstringNo
cityformstringNo
codeformstringNo
phone_homeformstringNo
phone_cellformstringNo
phone_busformstringNo
emailformstringNo
prefixformstringNo
dobformDateTime?No
citizenshipformstringNo
citizenship_otherformstringNo
permanent_residentformstringNo
denominationformstringNo
occupationformstringNo
ethnicityformstringNo
genderformstringNo
marital_statusformstringNo
deceased_dateformDateTime?No
added_byformstringNo
added_dateformDateTime?No
last_changed_byformstringNo
last_changed_dateformDateTime?No
addr_last_changed_byformstringNo
addr_last_changed_dateformDateTime?No
timestampformDateTimeNo
submitted_datetimeformDateTime?No
submitted_by_unauthenticated_person_idformint?No
authorized_datetimeformDateTime?No
authorized_by_person_idformint?No
archived_datetimeformDateTime?No
archived_by_person_idformint?No
UnauthenticatedStudentSectionRegistrationResponse Parameters:
NameParameterData TypeRequiredDescription
section_uuidformstringNo
student_section_uuidformstringNo
course_nameformstringNo
section_codeformstringNo
course_titleformstringNo
amountformdecimalNo
is_oncampusformboolNo
is_auditformboolNo
is_provisionalformboolNo
is_missing_requisitesformboolNo
is_other_restrictionformboolNo
added_dateformDateTime?No
added_by_person_idformint?No
changed_dateformDateTime?No
changed_by_person_idformint?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/Unauthenticated/{reporting_term}/{transaction_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reporting_term: String,
	transaction_uuid: 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
		}
	},
	transaction_uuid: String,
	notes_json: String,
	credit_hours: 0,
	audit_hours: 0,
	started_datetime: 0001-01-01,
	archived_datetime: 0001-01-01,
	submitted_datetime: 0001-01-01,
	authorized_datetime: 0001-01-01,
	person: 
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		regent_id: 0,
		reporting_term: String,
		survey: String,
		friend_referral: String,
		other_referral: String,
		is_returning: False,
		is_applying: False,
		is_landlord: False,
		postsecondary_education_level: 0,
		uuid: String,
		regent_login: String,
		first_name: String,
		middle_name: String,
		last_name: String,
		preferred_name: String,
		birth_name: String,
		spouse_name: String,
		addr1: String,
		addr2: String,
		country: String,
		state: String,
		city: String,
		code: String,
		phone_home: String,
		phone_cell: String,
		phone_bus: String,
		email: String,
		prefix: String,
		dob: 0001-01-01,
		citizenship: String,
		citizenship_other: String,
		permanent_resident: String,
		denomination: String,
		occupation: String,
		ethnicity: String,
		gender: String,
		marital_status: String,
		deceased_date: 0001-01-01,
		added_by: String,
		added_date: 0001-01-01,
		last_changed_by: String,
		last_changed_date: 0001-01-01,
		addr_last_changed_by: String,
		addr_last_changed_date: 0001-01-01,
		timestamp: 0001-01-01,
		submitted_datetime: 0001-01-01,
		submitted_by_unauthenticated_person_id: 0,
		authorized_datetime: 0001-01-01,
		authorized_by_person_id: 0,
		archived_datetime: 0001-01-01,
		archived_by_person_id: 0
	},
	registrations: 
	[
		{
			section_uuid: String,
			student_section_uuid: String,
			course_name: String,
			section_code: String,
			course_title: String,
			amount: 0,
			is_oncampus: False,
			is_audit: False,
			is_provisional: False,
			is_missing_requisites: False,
			is_other_restriction: False,
			added_date: 0001-01-01,
			added_by_person_id: 0,
			changed_date: 0001-01-01,
			changed_by_person_id: 0
		}
	]
}