regis

RegistrationSummaryRequest

**Requires Authentication**
Required permission:	ReadRegistrationAvailability

The following routes are available for this service:
POST	/registration/summary

**RegistrationSummaryRequest** Parameters:
Name	Parameter	Data Type	Required	Description
uuid	body	string	No
from_this_term	body	string	No

**RegistrationSummaryResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
regent_id	form	int	No
uuid	form	string	No
is_missing_tax_number	form	bool	No
person	form	PersonSimpleResponse	No
registrations	form	List<StudentAcademicCredentialByReportingTermSimpleResponse>	No
provisional_registrations	form	ProvisionalRegistrationsForStudentResponse	No

**PersonSimpleResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
regent_id	form	int	No
ubc_id	form	int?	No
uuid	form	string	No
regent_login	form	string	No
first_name	form	string	No
preferred_name	form	string	No
middle_name	form	string	No
last_name	form	string	No
email	form	string	No
phone_home	form	string	No
phone_cell	form	string	No
phone_bus	form	string	No
addr1	form	string	No
addr2	form	string	No
city	form	string	No
state	form	string	No
country	form	string	No
code	form	string	No
citizenship	form	string	No
citizenship_other	form	string	No
permanent_resident	form	string	No
dob	form	DateTime?	No
is_student	form	bool	No
is_faculty	form	bool	No
is_vendor	form	bool	No

**StudentAcademicCredentialByReportingTermSimpleResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
reportingTerm	form	string	No
OnlineCreditsAttempted	form	decimal	No
OnlineAuditsAttempted	form	decimal	No
studentAcademicCredentialSimpleResponse	form	List<StudentAcademicCredentialSimpleResponse>	No

**StudentAcademicCredentialSimpleResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
course_uuid	form	string	No
course_name	form	string	No
section_code	form	string	No
section_id	form	int?	No
term	form	string	No
reporting_term	form	string	No
title	form	string	No
amount	form	decimal?	No
is_audit	form	bool	No
is_pass_fail	form	bool	No
is_graded	form	bool	No

**ProvisionalRegistrationsForStudentResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
regent_id	form	int	No
uuid	form	string	No
provisional_registrations	form	List<ProvisionalRegistrationResponse>	No

**ProvisionalRegistrationResponse** Parameters:
Name	Parameter	Data Type	Required
uuid	form	string	No
regent_id	form	int?	No
student_name	form	string	No
email	form	string	No
section_uuid	form	string	No
student_section_uuid	form	string	No
course_name	form	string	No
section_code	form	string	No
title	form	string	No
term	form	string	No
amount	form	decimal	No
is_audit	form	bool	No
is_waitlist	form	bool	No
is_missing_requisites	form	bool	No
is_other_restriction	form	bool	No
documents	form	List<RegistrationDocumentResponse>	No
requested_date	form	DateTime	No

**RegistrationDocumentResponse** Parameters:
Name	Parameter	Data Type	Required
uuid	form	string	No
regent_id	form	int	No
first_name	form	string	No
last_name	form	string	No
gender	form	string	No
email	form	string	No
program	form	string	No
concentration	form	string	No
section_uuid	form	string	No
course_name	form	string	No
course_title	form	string	No
reporting_term	form	string	No
document_code	form	string	No
document_json	form	string	No
document_name	form	string	No
document_description	form	string	No
added_date	form	DateTime?	No
changed_date	form	DateTime?	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/summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	from_this_term: 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
		}
	},
	regent_id: 0,
	uuid: String,
	is_missing_tax_number: False,
	person: 
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		regent_id: 0,
		ubc_id: 0,
		uuid: String,
		regent_login: String,
		first_name: String,
		preferred_name: String,
		middle_name: String,
		last_name: String,
		email: String,
		phone_home: String,
		phone_cell: String,
		phone_bus: String,
		addr1: String,
		addr2: String,
		city: String,
		state: String,
		country: String,
		code: String,
		citizenship: String,
		citizenship_other: String,
		permanent_resident: String,
		dob: 0001-01-01,
		is_student: False,
		is_faculty: False,
		is_vendor: False
	},
	registrations: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			reportingTerm: String,
			onlineCreditsAttempted: 0,
			onlineAuditsAttempted: 0,
			studentAcademicCredentialSimpleResponse: 
			[
				{
					responseStatus: 
					{
						errorCode: String,
						message: String,
						stackTrace: String,
						errors: 
						[
							{
								errorCode: String,
								fieldName: String,
								message: String,
								meta: 
								{
									String: String
								}
							}
						],
						meta: 
						{
							String: String
						}
					},
					course_uuid: String,
					course_name: String,
					section_code: String,
					section_id: 0,
					term: String,
					reporting_term: String,
					title: String,
					amount: 0,
					is_audit: False,
					is_pass_fail: False,
					is_graded: False
				}
			]
		}
	],
	provisional_registrations: 
	{
		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,
		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
			}
		]
	}
}