regis

TranscriptRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Transcript/{uuid}

**TranscriptRequest** Parameters:
Name	Parameter	Data Type	Required
uuid	path	string	No
academic_level	body	string	No
override_all_restrictions	body	bool	No
override_nonfinancial_restrictions	body	bool	No
authorizing_uuid	body	string	No

**TranscriptResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
first_name	form	string	No
last_name	form	string	No
middle_name	form	string	No
override_name	form	string	No
regent_id	form	int	No
academic_level	form	string	No
dob	form	DateTime	No
previous_degrees	form	List<ExternalDegreeResponse>	No
student_programs	form	List<StudentProgramTranscriptResponse>	No
regent_degrees	form	List<RegentDegreeResponse>	No
student_academic_credentials	form	List<StudentAcademicCredentialTranscriptResponse>	No
transfer_credentials	form	List<StudentTransferCredentialsTranscriptResponse>	No
transcript_notes	form	List<string>	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

**StudentProgramTranscriptResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	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

**RegentDegreeResponse** Parameters:
Name	Parameter	Data Type	Required
id	form	int	No
program_code	form	string	No
program_name	form	string	No
concentration_code	form	string	No
concentration_name	form	string	No
graduation_month	form	DateTime?	No
start_date	form	DateTime?	No
end_date	form	DateTime?	No
gpa	form	decimal?	No
academic_level	form	string	No
commencement_date	form	DateTime?	No
added_date	form	DateTime?	No
added_by	form	string	No
changed_date	form	DateTime?	No
changed_by	form	string	No
timestamp	form	DateTime	No

**StudentAcademicCredentialTranscriptResponse** Parameters:
Name	Parameter	Data Type	Required	Description
registered_credits	form	decimal?	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

**StudentTransferCredentialsTranscriptResponse** Parameters:
Name	Parameter	Data Type	Required	Description
institution_name	form	string	No
transferCredits	form	List<StudentTransferCredentialTranscriptResponse>	No

**StudentTransferCredentialTranscriptResponse** Parameters:
Name	Parameter	Data Type	Required
course_name	form	string	No
title	form	string	No
is_advanced_standing	form	bool	No
credit_value	form	decimal?	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 /Transcript/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	academic_level: String,
	override_all_restrictions: False,
	override_nonfinancial_restrictions: False,
	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
		}
	},
	first_name: String,
	last_name: String,
	middle_name: String,
	override_name: String,
	regent_id: 0,
	academic_level: String,
	dob: 0001-01-01,
	previous_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
		}
	],
	student_programs: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			program_code: String,
			program_name: String,
			concentration_code: String,
			concentration_name: String,
			start_date: 0001-01-01
		}
	],
	regent_degrees: 
	[
		{
			id: 0,
			program_code: String,
			program_name: String,
			concentration_code: String,
			concentration_name: String,
			graduation_month: 0001-01-01,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			gpa: 0,
			academic_level: String,
			commencement_date: 0001-01-01,
			added_date: 0001-01-01,
			added_by: String,
			changed_date: 0001-01-01,
			changed_by: String,
			timestamp: 0001-01-01
		}
	],
	student_academic_credentials: 
	[
		{
			registered_credits: 0,
			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
		}
	],
	transfer_credentials: 
	[
		{
			institution_name: String,
			transferCredits: 
			[
				{
					course_name: String,
					title: String,
					is_advanced_standing: False,
					credit_value: 0
				}
			]
		}
	],
	transcript_notes: 
	[
		String
	]
}