regis

InstitutionStudentsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Academic/Institution/{institution_id}/Students

**InstitutionStudentsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
institution_id	path	int	No

**InstitutionStudentsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
student_transfer_credentials	form	List<StudentTransferCredentialsResponse>	No
student_previous_degrees	form	List<ExternalDegreesResponse>	No

**InstitutionResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
institution_id	form	int	No
institution_name	form	string	No
institution_previous_names	form	string	No
institution_other_names	form	string	No
institution_type	form	string	No
accreditation_status	form	string	No
accreditation_status_notes	form	string	No
related_institutions	form	List<string>	No
accreditation_status_changed_date	form	DateTime?	No
gpa_conversion	form	string	No
credit_hour_conversion	form	string	No
addr1	form	string	No
addr2	form	string	No
city	form	string	No
state	form	string	No
country	form	string	No
zip	form	string	No

**StudentTransferCredentialsResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
regent_id	form	int	No
uuid	form	string	No
studentTransferCredentialPackage	form	List<StudentTransferCredentialPackageResponse>	No

**StudentTransferCredentialPackageResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
equivalent_id	form	int	No
is_advanced_standing	form	bool	No
institution	form	InstitutionResponse	No
studentAcademicCredentials	form	List<StudentAcademicCredentialResponse>	No
studentTransferCredentials	form	List<StudentTransferCredentialResponse>	No

**StudentAcademicCredentialResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
uuid	form	string	No
stac_uuid	form	string	No
section_id	form	int?	No
course_name	form	string	No
section_code	form	string	No
subject	form	string	No
course_level	form	int?	No
title	form	string	No
pretty_title	form	string	No
location	form	string	No
is_audio	form	bool	No
is_oncampus	form	bool	No
credit_value	form	decimal?	No
audit_value	form	decimal?	No
is_audit	form	bool	No
is_pass_fail	form	bool	No
grade	form	string	No
is_grade_final	form	bool	No
gpa_credits	form	decimal?	No
grade_points	form	decimal?	No
academic_level	form	string	No
printed_comments	form	string	No
term	form	string	No
reporting_term	form	string	No
reporting_year	form	int?	No
current_status	form	string	No
added_by	form	string	No
added_date	form	DateTime?	No
changed_by	form	string	No
changed_date	form	DateTime?	No

**StudentTransferCredentialResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
uuid	form	string	No
stran_uuid	form	string	No
course_name	form	string	No
title	form	string	No
credit_value	form	decimal?	No
is_advanced_standing	form	bool	No
equivalent_id	form	int	No
institution_id	form	int	No
added_by	form	string	No
added_date	form	DateTime?	No
changed_by	form	string	No
changed_date	form	DateTime?	No

**ExternalDegreesResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
person	form	PersonSimpleResponse	No
gpa	form	decimal?	No
student_programs	form	List<StudentProgramSimpleResponse>	No
degrees	form	List<ExternalDegreeResponse>	No
valid_degrees	form	List<ExternalDegreesAdminResponse>	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

**StudentProgramSimpleResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
regent_id	form	int	No
uuid	form	string	No
program_id	form	int	No
program_code	form	string	No
program_name	form	string	No
concentration_code	form	string	No
concentration_name	form	string	No
start_date	form	DateTime?	No
end_date	form	DateTime?	No
catalog	form	string	No
is_active	form	bool	No
is_graduated	form	bool	No

**ExternalDegreeResponse** Parameters:
Name	Parameter	Data Type	Required
id	form	int?	No
institution_id	form	int?	No
degree_name	form	string	No
degree_override_name	form	string	No
institution_name	form	string	No
graduation_month	form	string	No
start_year	form	int?	No
end_year	form	int?	No
is_only_in_d365	form	bool	No

**ExternalDegreesAdminResponse** Parameters:
Name	Parameter	Data Type	Required
degree_code	form	string	No
degree_name	form	string	No
degree_type	form	string	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 /Academic/Institution/{institution_id}/Students HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	institution_id: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	student_transfer_credentials: 
	[
		{
			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,
			studentTransferCredentialPackage: 
			[
				{
					responseStatus: 
					{
						errorCode: String,
						message: String,
						stackTrace: String,
						errors: 
						[
							{
								errorCode: String,
								fieldName: String,
								message: String,
								meta: 
								{
									String: String
								}
							}
						],
						meta: 
						{
							String: String
						}
					},
					equivalent_id: 0,
					is_advanced_standing: False,
					institution: 
					{
						responseStatus: 
						{
							errorCode: String,
							message: String,
							stackTrace: String,
							errors: 
							[
								{
									errorCode: String,
									fieldName: String,
									message: String,
									meta: 
									{
										String: String
									}
								}
							],
							meta: 
							{
								String: String
							}
						},
						institution_id: 0,
						institution_name: String,
						institution_previous_names: String,
						institution_other_names: String,
						institution_type: String,
						accreditation_status: String,
						accreditation_status_notes: String,
						related_institutions: 
						[
							String
						],
						accreditation_status_changed_date: 0001-01-01,
						gpa_conversion: String,
						credit_hour_conversion: String,
						addr1: String,
						addr2: String,
						city: String,
						state: String,
						country: String,
						zip: String
					},
					studentAcademicCredentials: 
					[
						{
							responseStatus: 
							{
								errorCode: String,
								message: String,
								stackTrace: String,
								errors: 
								[
									{
										errorCode: String,
										fieldName: String,
										message: String,
										meta: 
										{
											String: String
										}
									}
								],
								meta: 
								{
									String: String
								}
							},
							uuid: String,
							stac_uuid: String,
							section_id: 0,
							course_name: String,
							section_code: String,
							subject: String,
							course_level: 0,
							title: String,
							pretty_title: String,
							location: String,
							is_audio: False,
							is_oncampus: False,
							credit_value: 0,
							audit_value: 0,
							is_audit: False,
							is_pass_fail: False,
							grade: String,
							is_grade_final: False,
							gpa_credits: 0,
							grade_points: 0,
							academic_level: String,
							printed_comments: String,
							term: String,
							reporting_term: String,
							reporting_year: 0,
							current_status: String,
							added_by: String,
							added_date: 0001-01-01,
							changed_by: String,
							changed_date: 0001-01-01
						}
					],
					studentTransferCredentials: 
					[
						{
							responseStatus: 
							{
								errorCode: String,
								message: String,
								stackTrace: String,
								errors: 
								[
									{
										errorCode: String,
										fieldName: String,
										message: String,
										meta: 
										{
											String: String
										}
									}
								],
								meta: 
								{
									String: String
								}
							},
							uuid: String,
							stran_uuid: String,
							course_name: String,
							title: String,
							credit_value: 0,
							is_advanced_standing: False,
							equivalent_id: 0,
							institution_id: 0,
							added_by: String,
							added_date: 0001-01-01,
							changed_by: String,
							changed_date: 0001-01-01
						}
					]
				}
			]
		}
	],
	student_previous_degrees: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			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
			},
			gpa: 0,
			student_programs: 
			[
				{
					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,
					program_id: 0,
					program_code: String,
					program_name: String,
					concentration_code: String,
					concentration_name: String,
					start_date: 0001-01-01,
					end_date: 0001-01-01,
					catalog: String,
					is_active: False,
					is_graduated: False
				}
			],
			degrees: 
			[
				{
					id: 0,
					institution_id: 0,
					degree_name: String,
					degree_override_name: String,
					institution_name: String,
					graduation_month: String,
					start_year: 0,
					end_year: 0,
					is_only_in_d365: False
				}
			],
			valid_degrees: 
			[
				{
					degree_code: String,
					degree_name: String,
					degree_type: String
				}
			]
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	institution_id: 0,
	institution_name: String,
	institution_previous_names: String,
	institution_other_names: String,
	institution_type: String,
	accreditation_status: String,
	accreditation_status_notes: String,
	related_institutions: 
	[
		String
	],
	accreditation_status_changed_date: 0001-01-01,
	gpa_conversion: String,
	credit_hour_conversion: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	zip: String
}