regis

TranscriptRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Transcript/{uuid}

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class TranscriptRequest
    {
        public virtual string uuid { get; set; }
        public virtual string academic_level { get; set; }
        public virtual bool override_all_restrictions { get; set; }
        public virtual bool override_nonfinancial_restrictions { get; set; }
        public virtual string authorizing_uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class ExternalDegreeResponse
    {
        public virtual int? id { get; set; }
        public virtual int? institution_id { get; set; }
        public virtual string degree_name { get; set; }
        public virtual string degree_override_name { get; set; }
        public virtual string institution_name { get; set; }
        public virtual string graduation_month { get; set; }
        public virtual int? start_year { get; set; }
        public virtual int? end_year { get; set; }
        public virtual bool is_only_in_d365 { get; set; }
    }

    public partial class RegentDegreeResponse
    {
        public virtual int id { get; set; }
        public virtual string program_code { get; set; }
        public virtual string program_name { get; set; }
        public virtual string concentration_code { get; set; }
        public virtual string concentration_name { get; set; }
        public virtual DateTime? graduation_month { get; set; }
        public virtual DateTime? start_date { get; set; }
        public virtual DateTime? end_date { get; set; }
        public virtual decimal? gpa { get; set; }
        public virtual string academic_level { get; set; }
        public virtual DateTime? commencement_date { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
        public virtual string changed_by { get; set; }
        public virtual DateTime timestamp { get; set; }
    }

    public partial class StudentAcademicCredentialResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string uuid { get; set; }
        public virtual string stac_uuid { get; set; }
        public virtual int? section_id { get; set; }
        public virtual string course_name { get; set; }
        public virtual string section_code { get; set; }
        public virtual string subject { get; set; }
        public virtual int? course_level { get; set; }
        public virtual string title { get; set; }
        public virtual string pretty_title { get; set; }
        public virtual string location { get; set; }
        public virtual bool is_audio { get; set; }
        public virtual bool is_oncampus { get; set; }
        public virtual decimal? credit_value { get; set; }
        public virtual decimal? audit_value { get; set; }
        public virtual bool is_audit { get; set; }
        public virtual bool is_pass_fail { get; set; }
        public virtual string grade { get; set; }
        public virtual bool is_grade_final { get; set; }
        public virtual decimal? gpa_credits { get; set; }
        public virtual decimal? grade_points { get; set; }
        public virtual string academic_level { get; set; }
        public virtual string printed_comments { get; set; }
        public virtual string term { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual int? reporting_year { get; set; }
        public virtual string current_status { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string changed_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
    }

    public partial class StudentAcademicCredentialTranscriptResponse
        : StudentAcademicCredentialResponse
    {
        public virtual decimal? registered_credits { get; set; }
    }

    public partial class StudentProgramTranscriptResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string program_code { get; set; }
        public virtual string program_name { get; set; }
        public virtual string concentration_code { get; set; }
        public virtual string concentration_name { get; set; }
        public virtual DateTime? start_date { get; set; }
    }

    public partial class StudentTransferCredentialsTranscriptResponse
    {
        public StudentTransferCredentialsTranscriptResponse()
        {
            transferCredits = new List<StudentTransferCredentialTranscriptResponse>{};
        }

        public virtual string institution_name { get; set; }
        public virtual List<StudentTransferCredentialTranscriptResponse> transferCredits { get; set; }
    }

    public partial class StudentTransferCredentialTranscriptResponse
    {
        public virtual string course_name { get; set; }
        public virtual string title { get; set; }
        public virtual bool is_advanced_standing { get; set; }
        public virtual decimal? credit_value { get; set; }
    }

    public partial class TranscriptResponse
    {
        public TranscriptResponse()
        {
            previous_degrees = new List<ExternalDegreeResponse>{};
            student_programs = new List<StudentProgramTranscriptResponse>{};
            regent_degrees = new List<RegentDegreeResponse>{};
            student_academic_credentials = new List<StudentAcademicCredentialTranscriptResponse>{};
            transfer_credentials = new List<StudentTransferCredentialsTranscriptResponse>{};
            transcript_notes = new List<string>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string middle_name { get; set; }
        public virtual string override_name { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string academic_level { get; set; }
        public virtual DateTime dob { get; set; }
        public virtual List<ExternalDegreeResponse> previous_degrees { get; set; }
        public virtual List<StudentProgramTranscriptResponse> student_programs { get; set; }
        public virtual List<RegentDegreeResponse> regent_degrees { get; set; }
        public virtual List<StudentAcademicCredentialTranscriptResponse> student_academic_credentials { get; set; }
        public virtual List<StudentTransferCredentialsTranscriptResponse> transfer_credentials { get; set; }
        public virtual List<string> transcript_notes { get; set; }
    }

}

C# 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>