regis

<back to all web services

StudentAcademicCredentialRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentAcademicCredential/{uuid}/{stac_uuid}
StudentAcademicCredentialRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
stac_uuidpathstringNo
StudentAcademicCredentialResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
uuidformstringNo
stac_uuidformstringNo
section_idformint?No
course_nameformstringNo
section_codeformstringNo
subjectformstringNo
course_levelformint?No
titleformstringNo
pretty_titleformstringNo
locationformstringNo
is_audioformboolNo
is_oncampusformboolNo
credit_valueformdecimal?No
audit_valueformdecimal?No
is_auditformboolNo
is_pass_failformboolNo
gradeformstringNo
is_grade_finalformboolNo
gpa_creditsformdecimal?No
grade_pointsformdecimal?No
academic_levelformstringNo
printed_commentsformstringNo
termformstringNo
reporting_termformstringNo
reporting_yearformint?No
current_statusformstringNo
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?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 /StudentAcademicCredential/{uuid}/{stac_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	stac_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
		}
	},
	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
}