| Required role: | REGISUserRole |
| POST | /Transcript/{uuid} |
|---|
import 'package:servicestack/servicestack.dart';
class ExternalDegreeResponse implements IConvertible
{
int? id;
int? institution_id;
String? degree_name;
String? degree_override_name;
String? institution_name;
String? graduation_month;
int? start_year;
int? end_year;
bool? is_only_in_d365;
ExternalDegreeResponse({this.id,this.institution_id,this.degree_name,this.degree_override_name,this.institution_name,this.graduation_month,this.start_year,this.end_year,this.is_only_in_d365});
ExternalDegreeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
institution_id = json['institution_id'];
degree_name = json['degree_name'];
degree_override_name = json['degree_override_name'];
institution_name = json['institution_name'];
graduation_month = json['graduation_month'];
start_year = json['start_year'];
end_year = json['end_year'];
is_only_in_d365 = json['is_only_in_d365'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'institution_id': institution_id,
'degree_name': degree_name,
'degree_override_name': degree_override_name,
'institution_name': institution_name,
'graduation_month': graduation_month,
'start_year': start_year,
'end_year': end_year,
'is_only_in_d365': is_only_in_d365
};
getTypeName() => "ExternalDegreeResponse";
TypeContext? context = _ctx;
}
class StudentProgramTranscriptResponse implements IConvertible
{
ResponseStatus? responseStatus;
String? program_code;
String? program_name;
String? concentration_code;
String? concentration_name;
DateTime? start_date;
StudentProgramTranscriptResponse({this.responseStatus,this.program_code,this.program_name,this.concentration_code,this.concentration_name,this.start_date});
StudentProgramTranscriptResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
program_code = json['program_code'];
program_name = json['program_name'];
concentration_code = json['concentration_code'];
concentration_name = json['concentration_name'];
start_date = JsonConverters.fromJson(json['start_date'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'program_code': program_code,
'program_name': program_name,
'concentration_code': concentration_code,
'concentration_name': concentration_name,
'start_date': JsonConverters.toJson(start_date,'DateTime',context!)
};
getTypeName() => "StudentProgramTranscriptResponse";
TypeContext? context = _ctx;
}
class RegentDegreeResponse implements IConvertible
{
int? id;
String? program_code;
String? program_name;
String? concentration_code;
String? concentration_name;
DateTime? graduation_month;
DateTime? start_date;
DateTime? end_date;
double? gpa;
String? academic_level;
DateTime? commencement_date;
DateTime? added_date;
String? added_by;
DateTime? changed_date;
String? changed_by;
DateTime? timestamp;
RegentDegreeResponse({this.id,this.program_code,this.program_name,this.concentration_code,this.concentration_name,this.graduation_month,this.start_date,this.end_date,this.gpa,this.academic_level,this.commencement_date,this.added_date,this.added_by,this.changed_date,this.changed_by,this.timestamp});
RegentDegreeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
program_code = json['program_code'];
program_name = json['program_name'];
concentration_code = json['concentration_code'];
concentration_name = json['concentration_name'];
graduation_month = JsonConverters.fromJson(json['graduation_month'],'DateTime',context!);
start_date = JsonConverters.fromJson(json['start_date'],'DateTime',context!);
end_date = JsonConverters.fromJson(json['end_date'],'DateTime',context!);
gpa = JsonConverters.toDouble(json['gpa']);
academic_level = json['academic_level'];
commencement_date = JsonConverters.fromJson(json['commencement_date'],'DateTime',context!);
added_date = JsonConverters.fromJson(json['added_date'],'DateTime',context!);
added_by = json['added_by'];
changed_date = JsonConverters.fromJson(json['changed_date'],'DateTime',context!);
changed_by = json['changed_by'];
timestamp = JsonConverters.fromJson(json['timestamp'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'program_code': program_code,
'program_name': program_name,
'concentration_code': concentration_code,
'concentration_name': concentration_name,
'graduation_month': JsonConverters.toJson(graduation_month,'DateTime',context!),
'start_date': JsonConverters.toJson(start_date,'DateTime',context!),
'end_date': JsonConverters.toJson(end_date,'DateTime',context!),
'gpa': gpa,
'academic_level': academic_level,
'commencement_date': JsonConverters.toJson(commencement_date,'DateTime',context!),
'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
'added_by': added_by,
'changed_date': JsonConverters.toJson(changed_date,'DateTime',context!),
'changed_by': changed_by,
'timestamp': JsonConverters.toJson(timestamp,'DateTime',context!)
};
getTypeName() => "RegentDegreeResponse";
TypeContext? context = _ctx;
}
class StudentAcademicCredentialResponse implements IConvertible
{
ResponseStatus? responseStatus;
String? uuid;
String? stac_uuid;
int? section_id;
String? course_name;
String? section_code;
String? subject;
int? course_level;
String? title;
String? pretty_title;
String? location;
bool? is_audio;
bool? is_oncampus;
double? credit_value;
double? audit_value;
bool? is_audit;
bool? is_pass_fail;
String? grade;
bool? is_grade_final;
double? gpa_credits;
double? grade_points;
String? academic_level;
String? printed_comments;
String? term;
String? reporting_term;
int? reporting_year;
String? current_status;
String? added_by;
DateTime? added_date;
String? changed_by;
DateTime? changed_date;
StudentAcademicCredentialResponse({this.responseStatus,this.uuid,this.stac_uuid,this.section_id,this.course_name,this.section_code,this.subject,this.course_level,this.title,this.pretty_title,this.location,this.is_audio,this.is_oncampus,this.credit_value,this.audit_value,this.is_audit,this.is_pass_fail,this.grade,this.is_grade_final,this.gpa_credits,this.grade_points,this.academic_level,this.printed_comments,this.term,this.reporting_term,this.reporting_year,this.current_status,this.added_by,this.added_date,this.changed_by,this.changed_date});
StudentAcademicCredentialResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
uuid = json['uuid'];
stac_uuid = json['stac_uuid'];
section_id = json['section_id'];
course_name = json['course_name'];
section_code = json['section_code'];
subject = json['subject'];
course_level = json['course_level'];
title = json['title'];
pretty_title = json['pretty_title'];
location = json['location'];
is_audio = json['is_audio'];
is_oncampus = json['is_oncampus'];
credit_value = JsonConverters.toDouble(json['credit_value']);
audit_value = JsonConverters.toDouble(json['audit_value']);
is_audit = json['is_audit'];
is_pass_fail = json['is_pass_fail'];
grade = json['grade'];
is_grade_final = json['is_grade_final'];
gpa_credits = JsonConverters.toDouble(json['gpa_credits']);
grade_points = JsonConverters.toDouble(json['grade_points']);
academic_level = json['academic_level'];
printed_comments = json['printed_comments'];
term = json['term'];
reporting_term = json['reporting_term'];
reporting_year = json['reporting_year'];
current_status = json['current_status'];
added_by = json['added_by'];
added_date = JsonConverters.fromJson(json['added_date'],'DateTime',context!);
changed_by = json['changed_by'];
changed_date = JsonConverters.fromJson(json['changed_date'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'uuid': uuid,
'stac_uuid': stac_uuid,
'section_id': section_id,
'course_name': course_name,
'section_code': section_code,
'subject': subject,
'course_level': course_level,
'title': title,
'pretty_title': pretty_title,
'location': location,
'is_audio': is_audio,
'is_oncampus': is_oncampus,
'credit_value': credit_value,
'audit_value': audit_value,
'is_audit': is_audit,
'is_pass_fail': is_pass_fail,
'grade': grade,
'is_grade_final': is_grade_final,
'gpa_credits': gpa_credits,
'grade_points': grade_points,
'academic_level': academic_level,
'printed_comments': printed_comments,
'term': term,
'reporting_term': reporting_term,
'reporting_year': reporting_year,
'current_status': current_status,
'added_by': added_by,
'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
'changed_by': changed_by,
'changed_date': JsonConverters.toJson(changed_date,'DateTime',context!)
};
getTypeName() => "StudentAcademicCredentialResponse";
TypeContext? context = _ctx;
}
class StudentAcademicCredentialTranscriptResponse extends StudentAcademicCredentialResponse implements IConvertible
{
double? registered_credits;
StudentAcademicCredentialTranscriptResponse({this.registered_credits});
StudentAcademicCredentialTranscriptResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
registered_credits = JsonConverters.toDouble(json['registered_credits']);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'registered_credits': registered_credits
});
getTypeName() => "StudentAcademicCredentialTranscriptResponse";
TypeContext? context = _ctx;
}
class StudentTransferCredentialTranscriptResponse implements IConvertible
{
String? course_name;
String? title;
bool? is_advanced_standing;
double? credit_value;
StudentTransferCredentialTranscriptResponse({this.course_name,this.title,this.is_advanced_standing,this.credit_value});
StudentTransferCredentialTranscriptResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
course_name = json['course_name'];
title = json['title'];
is_advanced_standing = json['is_advanced_standing'];
credit_value = JsonConverters.toDouble(json['credit_value']);
return this;
}
Map<String, dynamic> toJson() => {
'course_name': course_name,
'title': title,
'is_advanced_standing': is_advanced_standing,
'credit_value': credit_value
};
getTypeName() => "StudentTransferCredentialTranscriptResponse";
TypeContext? context = _ctx;
}
class StudentTransferCredentialsTranscriptResponse implements IConvertible
{
String? institution_name;
List<StudentTransferCredentialTranscriptResponse>? transferCredits;
StudentTransferCredentialsTranscriptResponse({this.institution_name,this.transferCredits});
StudentTransferCredentialsTranscriptResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
institution_name = json['institution_name'];
transferCredits = JsonConverters.fromJson(json['transferCredits'],'List<StudentTransferCredentialTranscriptResponse>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'institution_name': institution_name,
'transferCredits': JsonConverters.toJson(transferCredits,'List<StudentTransferCredentialTranscriptResponse>',context!)
};
getTypeName() => "StudentTransferCredentialsTranscriptResponse";
TypeContext? context = _ctx;
}
class TranscriptResponse implements IConvertible
{
ResponseStatus? responseStatus;
String? first_name;
String? last_name;
String? middle_name;
String? override_name;
int? regent_id;
String? academic_level;
DateTime? dob;
List<ExternalDegreeResponse>? previous_degrees;
List<StudentProgramTranscriptResponse>? student_programs;
List<RegentDegreeResponse>? regent_degrees;
List<StudentAcademicCredentialTranscriptResponse>? student_academic_credentials;
List<StudentTransferCredentialsTranscriptResponse>? transfer_credentials;
List<String>? transcript_notes;
TranscriptResponse({this.responseStatus,this.first_name,this.last_name,this.middle_name,this.override_name,this.regent_id,this.academic_level,this.dob,this.previous_degrees,this.student_programs,this.regent_degrees,this.student_academic_credentials,this.transfer_credentials,this.transcript_notes});
TranscriptResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
first_name = json['first_name'];
last_name = json['last_name'];
middle_name = json['middle_name'];
override_name = json['override_name'];
regent_id = json['regent_id'];
academic_level = json['academic_level'];
dob = JsonConverters.fromJson(json['dob'],'DateTime',context!);
previous_degrees = JsonConverters.fromJson(json['previous_degrees'],'List<ExternalDegreeResponse>',context!);
student_programs = JsonConverters.fromJson(json['student_programs'],'List<StudentProgramTranscriptResponse>',context!);
regent_degrees = JsonConverters.fromJson(json['regent_degrees'],'List<RegentDegreeResponse>',context!);
student_academic_credentials = JsonConverters.fromJson(json['student_academic_credentials'],'List<StudentAcademicCredentialTranscriptResponse>',context!);
transfer_credentials = JsonConverters.fromJson(json['transfer_credentials'],'List<StudentTransferCredentialsTranscriptResponse>',context!);
transcript_notes = JsonConverters.fromJson(json['transcript_notes'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'first_name': first_name,
'last_name': last_name,
'middle_name': middle_name,
'override_name': override_name,
'regent_id': regent_id,
'academic_level': academic_level,
'dob': JsonConverters.toJson(dob,'DateTime',context!),
'previous_degrees': JsonConverters.toJson(previous_degrees,'List<ExternalDegreeResponse>',context!),
'student_programs': JsonConverters.toJson(student_programs,'List<StudentProgramTranscriptResponse>',context!),
'regent_degrees': JsonConverters.toJson(regent_degrees,'List<RegentDegreeResponse>',context!),
'student_academic_credentials': JsonConverters.toJson(student_academic_credentials,'List<StudentAcademicCredentialTranscriptResponse>',context!),
'transfer_credentials': JsonConverters.toJson(transfer_credentials,'List<StudentTransferCredentialsTranscriptResponse>',context!),
'transcript_notes': JsonConverters.toJson(transcript_notes,'List<String>',context!)
};
getTypeName() => "TranscriptResponse";
TypeContext? context = _ctx;
}
class TranscriptRequest implements IConvertible
{
String? uuid;
String? academic_level;
bool? override_all_restrictions;
bool? override_nonfinancial_restrictions;
String? authorizing_uuid;
TranscriptRequest({this.uuid,this.academic_level,this.override_all_restrictions,this.override_nonfinancial_restrictions,this.authorizing_uuid});
TranscriptRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
uuid = json['uuid'];
academic_level = json['academic_level'];
override_all_restrictions = json['override_all_restrictions'];
override_nonfinancial_restrictions = json['override_nonfinancial_restrictions'];
authorizing_uuid = json['authorizing_uuid'];
return this;
}
Map<String, dynamic> toJson() => {
'uuid': uuid,
'academic_level': academic_level,
'override_all_restrictions': override_all_restrictions,
'override_nonfinancial_restrictions': override_nonfinancial_restrictions,
'authorizing_uuid': authorizing_uuid
};
getTypeName() => "TranscriptRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
'ExternalDegreeResponse': TypeInfo(TypeOf.Class, create:() => ExternalDegreeResponse()),
'StudentProgramTranscriptResponse': TypeInfo(TypeOf.Class, create:() => StudentProgramTranscriptResponse()),
'RegentDegreeResponse': TypeInfo(TypeOf.Class, create:() => RegentDegreeResponse()),
'StudentAcademicCredentialResponse': TypeInfo(TypeOf.Class, create:() => StudentAcademicCredentialResponse()),
'StudentAcademicCredentialTranscriptResponse': TypeInfo(TypeOf.Class, create:() => StudentAcademicCredentialTranscriptResponse()),
'StudentTransferCredentialTranscriptResponse': TypeInfo(TypeOf.Class, create:() => StudentTransferCredentialTranscriptResponse()),
'StudentTransferCredentialsTranscriptResponse': TypeInfo(TypeOf.Class, create:() => StudentTransferCredentialsTranscriptResponse()),
'List<StudentTransferCredentialTranscriptResponse>': TypeInfo(TypeOf.Class, create:() => <StudentTransferCredentialTranscriptResponse>[]),
'TranscriptResponse': TypeInfo(TypeOf.Class, create:() => TranscriptResponse()),
'List<ExternalDegreeResponse>': TypeInfo(TypeOf.Class, create:() => <ExternalDegreeResponse>[]),
'List<StudentProgramTranscriptResponse>': TypeInfo(TypeOf.Class, create:() => <StudentProgramTranscriptResponse>[]),
'List<RegentDegreeResponse>': TypeInfo(TypeOf.Class, create:() => <RegentDegreeResponse>[]),
'List<StudentAcademicCredentialTranscriptResponse>': TypeInfo(TypeOf.Class, create:() => <StudentAcademicCredentialTranscriptResponse>[]),
'List<StudentTransferCredentialsTranscriptResponse>': TypeInfo(TypeOf.Class, create:() => <StudentTransferCredentialsTranscriptResponse>[]),
'TranscriptRequest': TypeInfo(TypeOf.Class, create:() => TranscriptRequest()),
});
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
]
}