| Required role: | REGISUserRole |
| POST | /Transcript/{uuid} |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;
namespace regis.ClassLibrary.Requests
{
public partial class TranscriptRequest
{
public virtual string uuid { get; set; }
public virtual string academic_level { get; set; }
public virtual bool override_all_restrictions { get; set; }
public virtual bool override_nonfinancial_restrictions { get; set; }
public virtual string authorizing_uuid { get; set; }
}
}
namespace regis.ClassLibrary.Responses
{
public partial class ExternalDegreeResponse
{
public virtual int? id { get; set; }
public virtual int? institution_id { get; set; }
public virtual string degree_name { get; set; }
public virtual string degree_override_name { get; set; }
public virtual string institution_name { get; set; }
public virtual string graduation_month { get; set; }
public virtual int? start_year { get; set; }
public virtual int? end_year { get; set; }
public virtual bool is_only_in_d365 { get; set; }
}
public partial class RegentDegreeResponse
{
public virtual int id { get; set; }
public virtual string program_code { get; set; }
public virtual string program_name { get; set; }
public virtual string concentration_code { get; set; }
public virtual string concentration_name { get; set; }
public virtual DateTime? graduation_month { get; set; }
public virtual DateTime? start_date { get; set; }
public virtual DateTime? end_date { get; set; }
public virtual decimal? gpa { get; set; }
public virtual string academic_level { get; set; }
public virtual DateTime? commencement_date { get; set; }
public virtual DateTime? added_date { get; set; }
public virtual string added_by { get; set; }
public virtual DateTime? changed_date { get; set; }
public virtual string changed_by { get; set; }
public virtual DateTime timestamp { get; set; }
}
public partial class StudentAcademicCredentialResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual string uuid { get; set; }
public virtual string stac_uuid { get; set; }
public virtual int? section_id { get; set; }
public virtual string course_name { get; set; }
public virtual string section_code { get; set; }
public virtual string subject { get; set; }
public virtual int? course_level { get; set; }
public virtual string title { get; set; }
public virtual string pretty_title { get; set; }
public virtual string location { get; set; }
public virtual bool is_audio { get; set; }
public virtual bool is_oncampus { get; set; }
public virtual decimal? credit_value { get; set; }
public virtual decimal? audit_value { get; set; }
public virtual bool is_audit { get; set; }
public virtual bool is_pass_fail { get; set; }
public virtual string grade { get; set; }
public virtual bool is_grade_final { get; set; }
public virtual decimal? gpa_credits { get; set; }
public virtual decimal? grade_points { get; set; }
public virtual string academic_level { get; set; }
public virtual string printed_comments { get; set; }
public virtual string term { get; set; }
public virtual string reporting_term { get; set; }
public virtual int? reporting_year { get; set; }
public virtual string current_status { get; set; }
public virtual string added_by { get; set; }
public virtual DateTime? added_date { get; set; }
public virtual string changed_by { get; set; }
public virtual DateTime? changed_date { get; set; }
}
public partial class StudentAcademicCredentialTranscriptResponse
: StudentAcademicCredentialResponse
{
public virtual decimal? registered_credits { get; set; }
}
public partial class StudentProgramTranscriptResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual string program_code { get; set; }
public virtual string program_name { get; set; }
public virtual string concentration_code { get; set; }
public virtual string concentration_name { get; set; }
public virtual DateTime? start_date { get; set; }
}
public partial class StudentTransferCredentialsTranscriptResponse
{
public StudentTransferCredentialsTranscriptResponse()
{
transferCredits = new List<StudentTransferCredentialTranscriptResponse>{};
}
public virtual string institution_name { get; set; }
public virtual List<StudentTransferCredentialTranscriptResponse> transferCredits { get; set; }
}
public partial class StudentTransferCredentialTranscriptResponse
{
public virtual string course_name { get; set; }
public virtual string title { get; set; }
public virtual bool is_advanced_standing { get; set; }
public virtual decimal? credit_value { get; set; }
}
public partial class TranscriptResponse
{
public TranscriptResponse()
{
previous_degrees = new List<ExternalDegreeResponse>{};
student_programs = new List<StudentProgramTranscriptResponse>{};
regent_degrees = new List<RegentDegreeResponse>{};
student_academic_credentials = new List<StudentAcademicCredentialTranscriptResponse>{};
transfer_credentials = new List<StudentTransferCredentialsTranscriptResponse>{};
transcript_notes = new List<string>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual string first_name { get; set; }
public virtual string last_name { get; set; }
public virtual string middle_name { get; set; }
public virtual string override_name { get; set; }
public virtual int regent_id { get; set; }
public virtual string academic_level { get; set; }
public virtual DateTime dob { get; set; }
public virtual List<ExternalDegreeResponse> previous_degrees { get; set; }
public virtual List<StudentProgramTranscriptResponse> student_programs { get; set; }
public virtual List<RegentDegreeResponse> regent_degrees { get; set; }
public virtual List<StudentAcademicCredentialTranscriptResponse> student_academic_credentials { get; set; }
public virtual List<StudentTransferCredentialsTranscriptResponse> transfer_credentials { get; set; }
public virtual List<string> transcript_notes { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
]
}