regis

TranscriptRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
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

F# TranscriptRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<TranscriptRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <academic_level>String</academic_level>
  <authorizing_uuid>String</authorizing_uuid>
  <override_all_restrictions>false</override_all_restrictions>
  <override_nonfinancial_restrictions>false</override_nonfinancial_restrictions>
  <uuid>String</uuid>
</TranscriptRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TranscriptResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <academic_level>String</academic_level>
  <dob>0001-01-01T00:00:00</dob>
  <first_name>String</first_name>
  <last_name>String</last_name>
  <middle_name>String</middle_name>
  <override_name>String</override_name>
  <previous_degrees>
    <ExternalDegreeResponse>
      <degree_name>String</degree_name>
      <degree_override_name>String</degree_override_name>
      <end_year>0</end_year>
      <graduation_month>String</graduation_month>
      <id>0</id>
      <institution_id>0</institution_id>
      <institution_name>String</institution_name>
      <is_only_in_d365>false</is_only_in_d365>
      <start_year>0</start_year>
    </ExternalDegreeResponse>
  </previous_degrees>
  <regent_degrees>
    <RegentDegreeResponse>
      <academic_level>String</academic_level>
      <added_by>String</added_by>
      <added_date>0001-01-01T00:00:00</added_date>
      <changed_by>String</changed_by>
      <changed_date>0001-01-01T00:00:00</changed_date>
      <commencement_date>0001-01-01T00:00:00</commencement_date>
      <concentration_code>String</concentration_code>
      <concentration_name>String</concentration_name>
      <end_date>0001-01-01T00:00:00</end_date>
      <gpa>0</gpa>
      <graduation_month>0001-01-01T00:00:00</graduation_month>
      <id>0</id>
      <program_code>String</program_code>
      <program_name>String</program_name>
      <start_date>0001-01-01T00:00:00</start_date>
      <timestamp>0001-01-01T00:00:00</timestamp>
    </RegentDegreeResponse>
  </regent_degrees>
  <regent_id>0</regent_id>
  <student_academic_credentials>
    <StudentAcademicCredentialTranscriptResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <academic_level>String</academic_level>
      <added_by>String</added_by>
      <added_date>0001-01-01T00:00:00</added_date>
      <audit_value>0</audit_value>
      <changed_by>String</changed_by>
      <changed_date>0001-01-01T00:00:00</changed_date>
      <course_level>0</course_level>
      <course_name>String</course_name>
      <credit_value>0</credit_value>
      <current_status>String</current_status>
      <gpa_credits>0</gpa_credits>
      <grade>String</grade>
      <grade_points>0</grade_points>
      <is_audio>false</is_audio>
      <is_audit>false</is_audit>
      <is_grade_final>false</is_grade_final>
      <is_oncampus>false</is_oncampus>
      <is_pass_fail>false</is_pass_fail>
      <location>String</location>
      <pretty_title>String</pretty_title>
      <printed_comments>String</printed_comments>
      <reporting_term>String</reporting_term>
      <reporting_year>0</reporting_year>
      <section_code>String</section_code>
      <section_id>0</section_id>
      <stac_uuid>String</stac_uuid>
      <subject>String</subject>
      <term>String</term>
      <title>String</title>
      <uuid>String</uuid>
      <registered_credits>0</registered_credits>
    </StudentAcademicCredentialTranscriptResponse>
  </student_academic_credentials>
  <student_programs>
    <StudentProgramTranscriptResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <concentration_code>String</concentration_code>
      <concentration_name>String</concentration_name>
      <program_code>String</program_code>
      <program_name>String</program_name>
      <start_date>0001-01-01T00:00:00</start_date>
    </StudentProgramTranscriptResponse>
  </student_programs>
  <transcript_notes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </transcript_notes>
  <transfer_credentials>
    <StudentTransferCredentialsTranscriptResponse>
      <institution_name>String</institution_name>
      <transferCredits>
        <StudentTransferCredentialTranscriptResponse>
          <course_name>String</course_name>
          <credit_value>0</credit_value>
          <is_advanced_standing>false</is_advanced_standing>
          <title>String</title>
        </StudentTransferCredentialTranscriptResponse>
      </transferCredits>
    </StudentTransferCredentialsTranscriptResponse>
  </transfer_credentials>
</TranscriptResponse>