regis

<back to all web services

TranscriptRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Transcript/{uuid}
TranscriptRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
academic_levelbodystringNo
override_all_restrictionsbodyboolNo
override_nonfinancial_restrictionsbodyboolNo
authorizing_uuidbodystringNo
TranscriptResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
first_nameformstringNo
last_nameformstringNo
middle_nameformstringNo
override_nameformstringNo
regent_idformintNo
academic_levelformstringNo
dobformDateTimeNo
previous_degreesformList<ExternalDegreeResponse>No
student_programsformList<StudentProgramTranscriptResponse>No
regent_degreesformList<RegentDegreeResponse>No
student_academic_credentialsformList<StudentAcademicCredentialTranscriptResponse>No
transfer_credentialsformList<StudentTransferCredentialsTranscriptResponse>No
transcript_notesformList<string>No
ExternalDegreeResponse Parameters:
NameParameterData TypeRequiredDescription
idformint?No
institution_idformint?No
degree_nameformstringNo
degree_override_nameformstringNo
institution_nameformstringNo
graduation_monthformstringNo
start_yearformint?No
end_yearformint?No
is_only_in_d365formboolNo
StudentProgramTranscriptResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
program_codeformstringNo
program_nameformstringNo
concentration_codeformstringNo
concentration_nameformstringNo
start_dateformDateTime?No
RegentDegreeResponse Parameters:
NameParameterData TypeRequiredDescription
idformintNo
program_codeformstringNo
program_nameformstringNo
concentration_codeformstringNo
concentration_nameformstringNo
graduation_monthformDateTime?No
start_dateformDateTime?No
end_dateformDateTime?No
gpaformdecimal?No
academic_levelformstringNo
commencement_dateformDateTime?No
added_dateformDateTime?No
added_byformstringNo
changed_dateformDateTime?No
changed_byformstringNo
timestampformDateTimeNo
StudentAcademicCredentialTranscriptResponse Parameters:
NameParameterData TypeRequiredDescription
registered_creditsformdecimal?No
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
StudentTransferCredentialsTranscriptResponse Parameters:
NameParameterData TypeRequiredDescription
institution_nameformstringNo
transferCreditsformList<StudentTransferCredentialTranscriptResponse>No
StudentTransferCredentialTranscriptResponse Parameters:
NameParameterData TypeRequiredDescription
course_nameformstringNo
titleformstringNo
is_advanced_standingformboolNo
credit_valueformdecimal?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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-01T00:00:00.0000000","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-01T00:00:00.0000000"}],"regent_degrees":[{"id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","graduation_month":"0001-01-01T00:00:00.0000000","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","gpa":0,"academic_level":"String","commencement_date":"0001-01-01T00:00:00.0000000","added_date":"0001-01-01T00:00:00.0000000","added_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String","timestamp":"0001-01-01T00:00:00.0000000"}],"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-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}],"transfer_credentials":[{"institution_name":"String","transferCredits":[{"course_name":"String","title":"String","is_advanced_standing":false,"credit_value":0}]}],"transcript_notes":["String"]}