Required role: | REGISUserRole |
POST | /Transcript/{uuid} |
---|
namespace regis.ClassLibrary.Requests
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ExternalDegreeResponse() =
member val id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val institution_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val degree_name:String = null with get,set
member val degree_override_name:String = null with get,set
member val institution_name:String = null with get,set
member val graduation_month:String = null with get,set
member val start_year:Nullable<Int32> = new Nullable<Int32>() with get,set
member val end_year:Nullable<Int32> = new Nullable<Int32>() with get,set
member val is_only_in_d365:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type StudentProgramTranscriptResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val program_code:String = null with get,set
member val program_name:String = null with get,set
member val concentration_code:String = null with get,set
member val concentration_name:String = null with get,set
member val start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type RegentDegreeResponse() =
member val id:Int32 = new Int32() with get,set
member val program_code:String = null with get,set
member val program_name:String = null with get,set
member val concentration_code:String = null with get,set
member val concentration_name:String = null with get,set
member val graduation_month:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val gpa:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val academic_level:String = null with get,set
member val commencement_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val added_by:String = null with get,set
member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val changed_by:String = null with get,set
member val timestamp:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type StudentAcademicCredentialResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val uuid:String = null with get,set
member val stac_uuid:String = null with get,set
member val section_id:Nullable<Int32> = new Nullable<Int32>() with get,set
member val course_name:String = null with get,set
member val section_code:String = null with get,set
member val subject:String = null with get,set
member val course_level:Nullable<Int32> = new Nullable<Int32>() with get,set
member val title:String = null with get,set
member val pretty_title:String = null with get,set
member val location:String = null with get,set
member val is_audio:Boolean = new Boolean() with get,set
member val is_oncampus:Boolean = new Boolean() with get,set
member val credit_value:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val audit_value:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val is_audit:Boolean = new Boolean() with get,set
member val is_pass_fail:Boolean = new Boolean() with get,set
member val grade:String = null with get,set
member val is_grade_final:Boolean = new Boolean() with get,set
member val gpa_credits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val grade_points:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val academic_level:String = null with get,set
member val printed_comments:String = null with get,set
member val term:String = null with get,set
member val reporting_term:String = null with get,set
member val reporting_year:Nullable<Int32> = new Nullable<Int32>() with get,set
member val current_status:String = null with get,set
member val added_by:String = null with get,set
member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val changed_by:String = null with get,set
member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type StudentAcademicCredentialTranscriptResponse() =
inherit StudentAcademicCredentialResponse()
member val registered_credits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<AllowNullLiteral>]
type StudentTransferCredentialTranscriptResponse() =
member val course_name:String = null with get,set
member val title:String = null with get,set
member val is_advanced_standing:Boolean = new Boolean() with get,set
member val credit_value:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<AllowNullLiteral>]
type StudentTransferCredentialsTranscriptResponse() =
member val institution_name:String = null with get,set
member val transferCredits:ResizeArray<StudentTransferCredentialTranscriptResponse> = new ResizeArray<StudentTransferCredentialTranscriptResponse>() with get,set
[<AllowNullLiteral>]
type TranscriptResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val first_name:String = null with get,set
member val last_name:String = null with get,set
member val middle_name:String = null with get,set
member val override_name:String = null with get,set
member val regent_id:Int32 = new Int32() with get,set
member val academic_level:String = null with get,set
member val dob:DateTime = new DateTime() with get,set
member val previous_degrees:ResizeArray<ExternalDegreeResponse> = new ResizeArray<ExternalDegreeResponse>() with get,set
member val student_programs:ResizeArray<StudentProgramTranscriptResponse> = new ResizeArray<StudentProgramTranscriptResponse>() with get,set
member val regent_degrees:ResizeArray<RegentDegreeResponse> = new ResizeArray<RegentDegreeResponse>() with get,set
member val student_academic_credentials:ResizeArray<StudentAcademicCredentialTranscriptResponse> = new ResizeArray<StudentAcademicCredentialTranscriptResponse>() with get,set
member val transfer_credentials:ResizeArray<StudentTransferCredentialsTranscriptResponse> = new ResizeArray<StudentTransferCredentialsTranscriptResponse>() with get,set
member val transcript_notes:ResizeArray<String> = new ResizeArray<String>() with get,set
[<AllowNullLiteral>]
type TranscriptRequest() =
member val uuid:String = null with get,set
member val academic_level:String = null with get,set
member val override_all_restrictions:Boolean = new Boolean() with get,set
member val override_nonfinancial_restrictions:Boolean = new Boolean() with get,set
member val authorizing_uuid:String = null with 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 ] }