regis

<back to all web services

TranscriptRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Transcript/{uuid}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class TranscriptRequest
{
    var uuid:String? = null
    var academic_level:String? = null
    var override_all_restrictions:Boolean? = null
    var override_nonfinancial_restrictions:Boolean? = null
    var authorizing_uuid:String? = null
}

open class TranscriptResponse
{
    var responseStatus:ResponseStatus? = null
    var first_name:String? = null
    var last_name:String? = null
    var middle_name:String? = null
    var override_name:String? = null
    var regent_id:Int? = null
    var academic_level:String? = null
    var dob:Date? = null
    var previous_degrees:ArrayList<ExternalDegreeResponse> = ArrayList<ExternalDegreeResponse>()
    var student_programs:ArrayList<StudentProgramTranscriptResponse> = ArrayList<StudentProgramTranscriptResponse>()
    var regent_degrees:ArrayList<RegentDegreeResponse> = ArrayList<RegentDegreeResponse>()
    var student_academic_credentials:ArrayList<StudentAcademicCredentialTranscriptResponse> = ArrayList<StudentAcademicCredentialTranscriptResponse>()
    var transfer_credentials:ArrayList<StudentTransferCredentialsTranscriptResponse> = ArrayList<StudentTransferCredentialsTranscriptResponse>()
    var transcript_notes:ArrayList<String> = ArrayList<String>()
}

open class ExternalDegreeResponse
{
    var id:Int? = null
    var institution_id:Int? = null
    var degree_name:String? = null
    var degree_override_name:String? = null
    var institution_name:String? = null
    var graduation_month:String? = null
    var start_year:Int? = null
    var end_year:Int? = null
    var is_only_in_d365:Boolean? = null
}

open class StudentProgramTranscriptResponse
{
    var responseStatus:ResponseStatus? = null
    var program_code:String? = null
    var program_name:String? = null
    var concentration_code:String? = null
    var concentration_name:String? = null
    var start_date:Date? = null
}

open class RegentDegreeResponse
{
    var id:Int? = null
    var program_code:String? = null
    var program_name:String? = null
    var concentration_code:String? = null
    var concentration_name:String? = null
    var graduation_month:Date? = null
    var start_date:Date? = null
    var end_date:Date? = null
    var gpa:BigDecimal? = null
    var academic_level:String? = null
    var commencement_date:Date? = null
    var added_date:Date? = null
    var added_by:String? = null
    var changed_date:Date? = null
    var changed_by:String? = null
    var timestamp:Date? = null
}

open class StudentAcademicCredentialTranscriptResponse : StudentAcademicCredentialResponse()
{
    var registered_credits:BigDecimal? = null
}

open class StudentAcademicCredentialResponse
{
    var responseStatus:ResponseStatus? = null
    var uuid:String? = null
    var stac_uuid:String? = null
    var section_id:Int? = null
    var course_name:String? = null
    var section_code:String? = null
    var subject:String? = null
    var course_level:Int? = null
    var title:String? = null
    var pretty_title:String? = null
    var location:String? = null
    var is_audio:Boolean? = null
    var is_oncampus:Boolean? = null
    var credit_value:BigDecimal? = null
    var audit_value:BigDecimal? = null
    var is_audit:Boolean? = null
    var is_pass_fail:Boolean? = null
    var grade:String? = null
    var is_grade_final:Boolean? = null
    var gpa_credits:BigDecimal? = null
    var grade_points:BigDecimal? = null
    var academic_level:String? = null
    var printed_comments:String? = null
    var term:String? = null
    var reporting_term:String? = null
    var reporting_year:Int? = null
    var current_status:String? = null
    var added_by:String? = null
    var added_date:Date? = null
    var changed_by:String? = null
    var changed_date:Date? = null
}

open class StudentTransferCredentialsTranscriptResponse
{
    var institution_name:String? = null
    var transferCredits:ArrayList<StudentTransferCredentialTranscriptResponse> = ArrayList<StudentTransferCredentialTranscriptResponse>()
}

open class StudentTransferCredentialTranscriptResponse
{
    var course_name:String? = null
    var title:String? = null
    var is_advanced_standing:Boolean? = null
    var credit_value:BigDecimal? = null
}

Kotlin TranscriptRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
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"]}