regis

<back to all web services

TranscriptRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Transcript/{uuid}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class TranscriptRequest
            Public Overridable Property uuid As String
            Public Overridable Property academic_level As String
            Public Overridable Property override_all_restrictions As Boolean
            Public Overridable Property override_nonfinancial_restrictions As Boolean
            Public Overridable Property authorizing_uuid As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class ExternalDegreeResponse
            Public Overridable Property id As Nullable(Of Integer)
            Public Overridable Property institution_id As Nullable(Of Integer)
            Public Overridable Property degree_name As String
            Public Overridable Property degree_override_name As String
            Public Overridable Property institution_name As String
            Public Overridable Property graduation_month As String
            Public Overridable Property start_year As Nullable(Of Integer)
            Public Overridable Property end_year As Nullable(Of Integer)
            Public Overridable Property is_only_in_d365 As Boolean
        End Class

        Public Partial Class RegentDegreeResponse
            Public Overridable Property id As Integer
            Public Overridable Property program_code As String
            Public Overridable Property program_name As String
            Public Overridable Property concentration_code As String
            Public Overridable Property concentration_name As String
            Public Overridable Property graduation_month As Nullable(Of Date)
            Public Overridable Property start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
            Public Overridable Property gpa As Nullable(Of Decimal)
            Public Overridable Property academic_level As String
            Public Overridable Property commencement_date As Nullable(Of Date)
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property added_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property timestamp As Date
        End Class

        Public Partial Class StudentAcademicCredentialResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property uuid As String
            Public Overridable Property stac_uuid As String
            Public Overridable Property section_id As Nullable(Of Integer)
            Public Overridable Property course_name As String
            Public Overridable Property section_code As String
            Public Overridable Property subject As String
            Public Overridable Property course_level As Nullable(Of Integer)
            Public Overridable Property title As String
            Public Overridable Property pretty_title As String
            Public Overridable Property location As String
            Public Overridable Property is_audio As Boolean
            Public Overridable Property is_oncampus As Boolean
            Public Overridable Property credit_value As Nullable(Of Decimal)
            Public Overridable Property audit_value As Nullable(Of Decimal)
            Public Overridable Property is_audit As Boolean
            Public Overridable Property is_pass_fail As Boolean
            Public Overridable Property grade As String
            Public Overridable Property is_grade_final As Boolean
            Public Overridable Property gpa_credits As Nullable(Of Decimal)
            Public Overridable Property grade_points As Nullable(Of Decimal)
            Public Overridable Property academic_level As String
            Public Overridable Property printed_comments As String
            Public Overridable Property term As String
            Public Overridable Property reporting_term As String
            Public Overridable Property reporting_year As Nullable(Of Integer)
            Public Overridable Property current_status As String
            Public Overridable Property added_by As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
        End Class

        Public Partial Class StudentAcademicCredentialTranscriptResponse
            Inherits StudentAcademicCredentialResponse
            Public Overridable Property registered_credits As Nullable(Of Decimal)
        End Class

        Public Partial Class StudentProgramTranscriptResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property program_code As String
            Public Overridable Property program_name As String
            Public Overridable Property concentration_code As String
            Public Overridable Property concentration_name As String
            Public Overridable Property start_date As Nullable(Of Date)
        End Class

        Public Partial Class StudentTransferCredentialsTranscriptResponse
            Public Sub New()
                transferCredits = New List(Of StudentTransferCredentialTranscriptResponse)
            End Sub

            Public Overridable Property institution_name As String
            Public Overridable Property transferCredits As List(Of StudentTransferCredentialTranscriptResponse)
        End Class

        Public Partial Class StudentTransferCredentialTranscriptResponse
            Public Overridable Property course_name As String
            Public Overridable Property title As String
            Public Overridable Property is_advanced_standing As Boolean
            Public Overridable Property credit_value As Nullable(Of Decimal)
        End Class

        Public Partial Class TranscriptResponse
            Public Sub New()
                previous_degrees = New List(Of ExternalDegreeResponse)
                student_programs = New List(Of StudentProgramTranscriptResponse)
                regent_degrees = New List(Of RegentDegreeResponse)
                student_academic_credentials = New List(Of StudentAcademicCredentialTranscriptResponse)
                transfer_credentials = New List(Of StudentTransferCredentialsTranscriptResponse)
                transcript_notes = New List(Of String)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property first_name As String
            Public Overridable Property last_name As String
            Public Overridable Property middle_name As String
            Public Overridable Property override_name As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property academic_level As String
            Public Overridable Property dob As Date
            Public Overridable Property previous_degrees As List(Of ExternalDegreeResponse)
            Public Overridable Property student_programs As List(Of StudentProgramTranscriptResponse)
            Public Overridable Property regent_degrees As List(Of RegentDegreeResponse)
            Public Overridable Property student_academic_credentials As List(Of StudentAcademicCredentialTranscriptResponse)
            Public Overridable Property transfer_credentials As List(Of StudentTransferCredentialsTranscriptResponse)
            Public Overridable Property transcript_notes As List(Of String)
        End Class
    End Namespace
End Namespace

VB.NET 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"]}