| Required role: | REGISUserRole |
| POST | /Transcript/{uuid} |
|---|
import Foundation
import ServiceStack
public class TranscriptRequest : Codable
{
public var uuid:String
public var academic_level:String
public var override_all_restrictions:Bool
public var override_nonfinancial_restrictions:Bool
public var authorizing_uuid:String
required public init(){}
}
public class TranscriptResponse : Codable
{
public var responseStatus:ResponseStatus
public var first_name:String
public var last_name:String
public var middle_name:String
public var override_name:String
public var regent_id:Int
public var academic_level:String
public var dob:Date
public var previous_degrees:[ExternalDegreeResponse] = []
public var student_programs:[StudentProgramTranscriptResponse] = []
public var regent_degrees:[RegentDegreeResponse] = []
public var student_academic_credentials:[StudentAcademicCredentialTranscriptResponse] = []
public var transfer_credentials:[StudentTransferCredentialsTranscriptResponse] = []
public var transcript_notes:[String] = []
required public init(){}
}
public class ExternalDegreeResponse : Codable
{
public var id:Int?
public var institution_id:Int?
public var degree_name:String
public var degree_override_name:String
public var institution_name:String
public var graduation_month:String
public var start_year:Int?
public var end_year:Int?
public var is_only_in_d365:Bool
required public init(){}
}
public class StudentProgramTranscriptResponse : Codable
{
public var responseStatus:ResponseStatus
public var program_code:String
public var program_name:String
public var concentration_code:String
public var concentration_name:String
public var start_date:Date?
required public init(){}
}
public class RegentDegreeResponse : Codable
{
public var id:Int
public var program_code:String
public var program_name:String
public var concentration_code:String
public var concentration_name:String
public var graduation_month:Date?
public var start_date:Date?
public var end_date:Date?
public var gpa:Double?
public var academic_level:String
public var commencement_date:Date?
public var added_date:Date?
public var added_by:String
public var changed_date:Date?
public var changed_by:String
public var timestamp:Date
required public init(){}
}
public class StudentAcademicCredentialTranscriptResponse : StudentAcademicCredentialResponse
{
public var registered_credits:Double?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case registered_credits
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
registered_credits = try container.decodeIfPresent(Double.self, forKey: .registered_credits)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if registered_credits != nil { try container.encode(registered_credits, forKey: .registered_credits) }
}
}
public class StudentAcademicCredentialResponse : Codable
{
public var responseStatus:ResponseStatus
public var uuid:String
public var stac_uuid:String
public var section_id:Int?
public var course_name:String
public var section_code:String
public var subject:String
public var course_level:Int?
public var title:String
public var pretty_title:String
public var location:String
public var is_audio:Bool
public var is_oncampus:Bool
public var credit_value:Double?
public var audit_value:Double?
public var is_audit:Bool
public var is_pass_fail:Bool
public var grade:String
public var is_grade_final:Bool
public var gpa_credits:Double?
public var grade_points:Double?
public var academic_level:String
public var printed_comments:String
public var term:String
public var reporting_term:String
public var reporting_year:Int?
public var current_status:String
public var added_by:String
public var added_date:Date?
public var changed_by:String
public var changed_date:Date?
required public init(){}
}
public class StudentTransferCredentialsTranscriptResponse : Codable
{
public var institution_name:String
public var transferCredits:[StudentTransferCredentialTranscriptResponse] = []
required public init(){}
}
public class StudentTransferCredentialTranscriptResponse : Codable
{
public var course_name:String
public var title:String
public var is_advanced_standing:Bool
public var credit_value:Double?
required public init(){}
}
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
]
}