regis

<back to all web services

TranscriptBatchRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Transcript/Batch
TranscriptBatchRequest Parameters:
NameParameterData TypeRequiredDescription
regent_idsbodyList<string>No
override_restrictionsbodyboolNo
academic_levelbodystringNo
authorizing_uuidbodystringNo

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

{
	regent_ids: 
	[
		String
	],
	override_restrictions: False,
	academic_level: 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
			}
		},
		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
		]
	}
]