regis

<back to all web services

UnauthenticatedRegistrationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Unauthenticated/{reporting_term}
UnauthenticatedRegistrationsRequest Parameters:
NameParameterData TypeRequiredDescription
reporting_termpathstringNo
is_submittedbodyboolNo
is_authorizedbodyboolNo
is_archivedbodyboolNo

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

{
	reporting_term: String,
	is_submitted: False,
	is_authorized: False,
	is_archived: False
}
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
			}
		]
	}
]