regis

TranscriptBatchRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Transcript/Batch

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class TranscriptBatchRequest implements JsonSerializable
{
    public function __construct(
        /** @var array<string>|null */
        public ?array $regent_ids=null,
        /** @var bool|null */
        public ?bool $override_restrictions=null,
        /** @var string|null */
        public ?string $academic_level=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['regent_ids'])) $this->regent_ids = JsonConverters::fromArray('string', $o['regent_ids']);
        if (isset($o['override_restrictions'])) $this->override_restrictions = $o['override_restrictions'];
        if (isset($o['academic_level'])) $this->academic_level = $o['academic_level'];
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->regent_ids)) $o['regent_ids'] = JsonConverters::toArray('string', $this->regent_ids);
        if (isset($this->override_restrictions)) $o['override_restrictions'] = $this->override_restrictions;
        if (isset($this->academic_level)) $o['academic_level'] = $this->academic_level;
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP TranscriptBatchRequest 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/Batch HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TranscriptBatchRequest 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_restrictions>false</override_restrictions>
  <regent_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </regent_ids>
</TranscriptBatchRequest>

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

<ArrayOfTranscriptResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <TranscriptResponse>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1: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:d5p1="http://schemas.servicestack.net/types">
          <d5p1:ErrorCode>String</d5p1:ErrorCode>
          <d5p1:Message>String</d5p1:Message>
          <d5p1:StackTrace>String</d5p1:StackTrace>
          <d5p1:Errors>
            <d5p1:ResponseError>
              <d5p1:ErrorCode>String</d5p1:ErrorCode>
              <d5p1:FieldName>String</d5p1:FieldName>
              <d5p1:Message>String</d5p1:Message>
              <d5p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:KeyValueOfstringstring>
                  <d8p1:Key>String</d8p1:Key>
                  <d8p1:Value>String</d8p1:Value>
                </d8p1:KeyValueOfstringstring>
              </d5p1:Meta>
            </d5p1:ResponseError>
          </d5p1:Errors>
          <d5p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d5p1: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:d5p1="http://schemas.servicestack.net/types">
          <d5p1:ErrorCode>String</d5p1:ErrorCode>
          <d5p1:Message>String</d5p1:Message>
          <d5p1:StackTrace>String</d5p1:StackTrace>
          <d5p1:Errors>
            <d5p1:ResponseError>
              <d5p1:ErrorCode>String</d5p1:ErrorCode>
              <d5p1:FieldName>String</d5p1:FieldName>
              <d5p1:Message>String</d5p1:Message>
              <d5p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:KeyValueOfstringstring>
                  <d8p1:Key>String</d8p1:Key>
                  <d8p1:Value>String</d8p1:Value>
                </d8p1:KeyValueOfstringstring>
              </d5p1:Meta>
            </d5p1:ResponseError>
          </d5p1:Errors>
          <d5p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d5p1: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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1: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>
</ArrayOfTranscriptResponse>