regis

<back to all web services

TranscriptRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Transcript/{uuid}
<?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 ExternalDegreeResponse implements JsonSerializable
{
    public function __construct(
        /** @var int|null */
        public ?int $id=null,
        /** @var int|null */
        public ?int $institution_id=null,
        /** @var string|null */
        public ?string $degree_name=null,
        /** @var string|null */
        public ?string $degree_override_name=null,
        /** @var string|null */
        public ?string $institution_name=null,
        /** @var string|null */
        public ?string $graduation_month=null,
        /** @var int|null */
        public ?int $start_year=null,
        /** @var int|null */
        public ?int $end_year=null,
        /** @var bool|null */
        public ?bool $is_only_in_d365=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['institution_id'])) $this->institution_id = $o['institution_id'];
        if (isset($o['degree_name'])) $this->degree_name = $o['degree_name'];
        if (isset($o['degree_override_name'])) $this->degree_override_name = $o['degree_override_name'];
        if (isset($o['institution_name'])) $this->institution_name = $o['institution_name'];
        if (isset($o['graduation_month'])) $this->graduation_month = $o['graduation_month'];
        if (isset($o['start_year'])) $this->start_year = $o['start_year'];
        if (isset($o['end_year'])) $this->end_year = $o['end_year'];
        if (isset($o['is_only_in_d365'])) $this->is_only_in_d365 = $o['is_only_in_d365'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->institution_id)) $o['institution_id'] = $this->institution_id;
        if (isset($this->degree_name)) $o['degree_name'] = $this->degree_name;
        if (isset($this->degree_override_name)) $o['degree_override_name'] = $this->degree_override_name;
        if (isset($this->institution_name)) $o['institution_name'] = $this->institution_name;
        if (isset($this->graduation_month)) $o['graduation_month'] = $this->graduation_month;
        if (isset($this->start_year)) $o['start_year'] = $this->start_year;
        if (isset($this->end_year)) $o['end_year'] = $this->end_year;
        if (isset($this->is_only_in_d365)) $o['is_only_in_d365'] = $this->is_only_in_d365;
        return empty($o) ? new class(){} : $o;
    }
}

class StudentProgramTranscriptResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $program_code=null,
        /** @var string|null */
        public ?string $program_name=null,
        /** @var string|null */
        public ?string $concentration_code=null,
        /** @var string|null */
        public ?string $concentration_name=null,
        /** @var DateTime|null */
        public ?DateTime $start_date=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['program_code'])) $this->program_code = $o['program_code'];
        if (isset($o['program_name'])) $this->program_name = $o['program_name'];
        if (isset($o['concentration_code'])) $this->concentration_code = $o['concentration_code'];
        if (isset($o['concentration_name'])) $this->concentration_name = $o['concentration_name'];
        if (isset($o['start_date'])) $this->start_date = JsonConverters::from('DateTime', $o['start_date']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->program_code)) $o['program_code'] = $this->program_code;
        if (isset($this->program_name)) $o['program_name'] = $this->program_name;
        if (isset($this->concentration_code)) $o['concentration_code'] = $this->concentration_code;
        if (isset($this->concentration_name)) $o['concentration_name'] = $this->concentration_name;
        if (isset($this->start_date)) $o['start_date'] = JsonConverters::to('DateTime', $this->start_date);
        return empty($o) ? new class(){} : $o;
    }
}

class RegentDegreeResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var string|null */
        public ?string $program_code=null,
        /** @var string|null */
        public ?string $program_name=null,
        /** @var string|null */
        public ?string $concentration_code=null,
        /** @var string|null */
        public ?string $concentration_name=null,
        /** @var DateTime|null */
        public ?DateTime $graduation_month=null,
        /** @var DateTime|null */
        public ?DateTime $start_date=null,
        /** @var DateTime|null */
        public ?DateTime $end_date=null,
        /** @var float|null */
        public ?float $gpa=null,
        /** @var string|null */
        public ?string $academic_level=null,
        /** @var DateTime|null */
        public ?DateTime $commencement_date=null,
        /** @var DateTime|null */
        public ?DateTime $added_date=null,
        /** @var string|null */
        public ?string $added_by=null,
        /** @var DateTime|null */
        public ?DateTime $changed_date=null,
        /** @var string|null */
        public ?string $changed_by=null,
        /** @var DateTime */
        public DateTime $timestamp=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['program_code'])) $this->program_code = $o['program_code'];
        if (isset($o['program_name'])) $this->program_name = $o['program_name'];
        if (isset($o['concentration_code'])) $this->concentration_code = $o['concentration_code'];
        if (isset($o['concentration_name'])) $this->concentration_name = $o['concentration_name'];
        if (isset($o['graduation_month'])) $this->graduation_month = JsonConverters::from('DateTime', $o['graduation_month']);
        if (isset($o['start_date'])) $this->start_date = JsonConverters::from('DateTime', $o['start_date']);
        if (isset($o['end_date'])) $this->end_date = JsonConverters::from('DateTime', $o['end_date']);
        if (isset($o['gpa'])) $this->gpa = $o['gpa'];
        if (isset($o['academic_level'])) $this->academic_level = $o['academic_level'];
        if (isset($o['commencement_date'])) $this->commencement_date = JsonConverters::from('DateTime', $o['commencement_date']);
        if (isset($o['added_date'])) $this->added_date = JsonConverters::from('DateTime', $o['added_date']);
        if (isset($o['added_by'])) $this->added_by = $o['added_by'];
        if (isset($o['changed_date'])) $this->changed_date = JsonConverters::from('DateTime', $o['changed_date']);
        if (isset($o['changed_by'])) $this->changed_by = $o['changed_by'];
        if (isset($o['timestamp'])) $this->timestamp = JsonConverters::from('DateTime', $o['timestamp']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->program_code)) $o['program_code'] = $this->program_code;
        if (isset($this->program_name)) $o['program_name'] = $this->program_name;
        if (isset($this->concentration_code)) $o['concentration_code'] = $this->concentration_code;
        if (isset($this->concentration_name)) $o['concentration_name'] = $this->concentration_name;
        if (isset($this->graduation_month)) $o['graduation_month'] = JsonConverters::to('DateTime', $this->graduation_month);
        if (isset($this->start_date)) $o['start_date'] = JsonConverters::to('DateTime', $this->start_date);
        if (isset($this->end_date)) $o['end_date'] = JsonConverters::to('DateTime', $this->end_date);
        if (isset($this->gpa)) $o['gpa'] = $this->gpa;
        if (isset($this->academic_level)) $o['academic_level'] = $this->academic_level;
        if (isset($this->commencement_date)) $o['commencement_date'] = JsonConverters::to('DateTime', $this->commencement_date);
        if (isset($this->added_date)) $o['added_date'] = JsonConverters::to('DateTime', $this->added_date);
        if (isset($this->added_by)) $o['added_by'] = $this->added_by;
        if (isset($this->changed_date)) $o['changed_date'] = JsonConverters::to('DateTime', $this->changed_date);
        if (isset($this->changed_by)) $o['changed_by'] = $this->changed_by;
        if (isset($this->timestamp)) $o['timestamp'] = JsonConverters::to('DateTime', $this->timestamp);
        return empty($o) ? new class(){} : $o;
    }
}

class StudentAcademicCredentialResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $stac_uuid=null,
        /** @var int|null */
        public ?int $section_id=null,
        /** @var string|null */
        public ?string $course_name=null,
        /** @var string|null */
        public ?string $section_code=null,
        /** @var string|null */
        public ?string $subject=null,
        /** @var int|null */
        public ?int $course_level=null,
        /** @var string|null */
        public ?string $title=null,
        /** @var string|null */
        public ?string $pretty_title=null,
        /** @var string|null */
        public ?string $location=null,
        /** @var bool|null */
        public ?bool $is_audio=null,
        /** @var bool|null */
        public ?bool $is_oncampus=null,
        /** @var float|null */
        public ?float $credit_value=null,
        /** @var float|null */
        public ?float $audit_value=null,
        /** @var bool|null */
        public ?bool $is_audit=null,
        /** @var bool|null */
        public ?bool $is_pass_fail=null,
        /** @var string|null */
        public ?string $grade=null,
        /** @var bool|null */
        public ?bool $is_grade_final=null,
        /** @var float|null */
        public ?float $gpa_credits=null,
        /** @var float|null */
        public ?float $grade_points=null,
        /** @var string|null */
        public ?string $academic_level=null,
        /** @var string|null */
        public ?string $printed_comments=null,
        /** @var string|null */
        public ?string $term=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var int|null */
        public ?int $reporting_year=null,
        /** @var string|null */
        public ?string $current_status=null,
        /** @var string|null */
        public ?string $added_by=null,
        /** @var DateTime|null */
        public ?DateTime $added_date=null,
        /** @var string|null */
        public ?string $changed_by=null,
        /** @var DateTime|null */
        public ?DateTime $changed_date=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['stac_uuid'])) $this->stac_uuid = $o['stac_uuid'];
        if (isset($o['section_id'])) $this->section_id = $o['section_id'];
        if (isset($o['course_name'])) $this->course_name = $o['course_name'];
        if (isset($o['section_code'])) $this->section_code = $o['section_code'];
        if (isset($o['subject'])) $this->subject = $o['subject'];
        if (isset($o['course_level'])) $this->course_level = $o['course_level'];
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['pretty_title'])) $this->pretty_title = $o['pretty_title'];
        if (isset($o['location'])) $this->location = $o['location'];
        if (isset($o['is_audio'])) $this->is_audio = $o['is_audio'];
        if (isset($o['is_oncampus'])) $this->is_oncampus = $o['is_oncampus'];
        if (isset($o['credit_value'])) $this->credit_value = $o['credit_value'];
        if (isset($o['audit_value'])) $this->audit_value = $o['audit_value'];
        if (isset($o['is_audit'])) $this->is_audit = $o['is_audit'];
        if (isset($o['is_pass_fail'])) $this->is_pass_fail = $o['is_pass_fail'];
        if (isset($o['grade'])) $this->grade = $o['grade'];
        if (isset($o['is_grade_final'])) $this->is_grade_final = $o['is_grade_final'];
        if (isset($o['gpa_credits'])) $this->gpa_credits = $o['gpa_credits'];
        if (isset($o['grade_points'])) $this->grade_points = $o['grade_points'];
        if (isset($o['academic_level'])) $this->academic_level = $o['academic_level'];
        if (isset($o['printed_comments'])) $this->printed_comments = $o['printed_comments'];
        if (isset($o['term'])) $this->term = $o['term'];
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['reporting_year'])) $this->reporting_year = $o['reporting_year'];
        if (isset($o['current_status'])) $this->current_status = $o['current_status'];
        if (isset($o['added_by'])) $this->added_by = $o['added_by'];
        if (isset($o['added_date'])) $this->added_date = JsonConverters::from('DateTime', $o['added_date']);
        if (isset($o['changed_by'])) $this->changed_by = $o['changed_by'];
        if (isset($o['changed_date'])) $this->changed_date = JsonConverters::from('DateTime', $o['changed_date']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->stac_uuid)) $o['stac_uuid'] = $this->stac_uuid;
        if (isset($this->section_id)) $o['section_id'] = $this->section_id;
        if (isset($this->course_name)) $o['course_name'] = $this->course_name;
        if (isset($this->section_code)) $o['section_code'] = $this->section_code;
        if (isset($this->subject)) $o['subject'] = $this->subject;
        if (isset($this->course_level)) $o['course_level'] = $this->course_level;
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->pretty_title)) $o['pretty_title'] = $this->pretty_title;
        if (isset($this->location)) $o['location'] = $this->location;
        if (isset($this->is_audio)) $o['is_audio'] = $this->is_audio;
        if (isset($this->is_oncampus)) $o['is_oncampus'] = $this->is_oncampus;
        if (isset($this->credit_value)) $o['credit_value'] = $this->credit_value;
        if (isset($this->audit_value)) $o['audit_value'] = $this->audit_value;
        if (isset($this->is_audit)) $o['is_audit'] = $this->is_audit;
        if (isset($this->is_pass_fail)) $o['is_pass_fail'] = $this->is_pass_fail;
        if (isset($this->grade)) $o['grade'] = $this->grade;
        if (isset($this->is_grade_final)) $o['is_grade_final'] = $this->is_grade_final;
        if (isset($this->gpa_credits)) $o['gpa_credits'] = $this->gpa_credits;
        if (isset($this->grade_points)) $o['grade_points'] = $this->grade_points;
        if (isset($this->academic_level)) $o['academic_level'] = $this->academic_level;
        if (isset($this->printed_comments)) $o['printed_comments'] = $this->printed_comments;
        if (isset($this->term)) $o['term'] = $this->term;
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->reporting_year)) $o['reporting_year'] = $this->reporting_year;
        if (isset($this->current_status)) $o['current_status'] = $this->current_status;
        if (isset($this->added_by)) $o['added_by'] = $this->added_by;
        if (isset($this->added_date)) $o['added_date'] = JsonConverters::to('DateTime', $this->added_date);
        if (isset($this->changed_by)) $o['changed_by'] = $this->changed_by;
        if (isset($this->changed_date)) $o['changed_date'] = JsonConverters::to('DateTime', $this->changed_date);
        return empty($o) ? new class(){} : $o;
    }
}

class StudentAcademicCredentialTranscriptResponse extends StudentAcademicCredentialResponse implements JsonSerializable
{
    /**
     * @param ResponseStatus|null $responseStatus
     * @param string|null $uuid
     * @param string|null $stac_uuid
     * @param int|null $section_id
     * @param string|null $course_name
     * @param string|null $section_code
     * @param string|null $subject
     * @param int|null $course_level
     * @param string|null $title
     * @param string|null $pretty_title
     * @param string|null $location
     * @param bool|null $is_audio
     * @param bool|null $is_oncampus
     * @param float|null $credit_value
     * @param float|null $audit_value
     * @param bool|null $is_audit
     * @param bool|null $is_pass_fail
     * @param string|null $grade
     * @param bool|null $is_grade_final
     * @param float|null $gpa_credits
     * @param float|null $grade_points
     * @param string|null $academic_level
     * @param string|null $printed_comments
     * @param string|null $term
     * @param string|null $reporting_term
     * @param int|null $reporting_year
     * @param string|null $current_status
     * @param string|null $added_by
     * @param DateTime|null $added_date
     * @param string|null $changed_by
     * @param DateTime|null $changed_date
     */
    public function __construct(
        ?ResponseStatus $responseStatus=null,
        ?string $uuid=null,
        ?string $stac_uuid=null,
        ?int $section_id=null,
        ?string $course_name=null,
        ?string $section_code=null,
        ?string $subject=null,
        ?int $course_level=null,
        ?string $title=null,
        ?string $pretty_title=null,
        ?string $location=null,
        ?bool $is_audio=null,
        ?bool $is_oncampus=null,
        ?float $credit_value=null,
        ?float $audit_value=null,
        ?bool $is_audit=null,
        ?bool $is_pass_fail=null,
        ?string $grade=null,
        ?bool $is_grade_final=null,
        ?float $gpa_credits=null,
        ?float $grade_points=null,
        ?string $academic_level=null,
        ?string $printed_comments=null,
        ?string $term=null,
        ?string $reporting_term=null,
        ?int $reporting_year=null,
        ?string $current_status=null,
        ?string $added_by=null,
        ?DateTime $added_date=null,
        ?string $changed_by=null,
        ?DateTime $changed_date=null,
        /** @var float|null */
        public ?float $registered_credits=null
    ) {
        parent::__construct($responseStatus,$uuid,$stac_uuid,$section_id,$course_name,$section_code,$subject,$course_level,$title,$pretty_title,$location,$is_audio,$is_oncampus,$credit_value,$audit_value,$is_audit,$is_pass_fail,$grade,$is_grade_final,$gpa_credits,$grade_points,$academic_level,$printed_comments,$term,$reporting_term,$reporting_year,$current_status,$added_by,$added_date,$changed_by,$changed_date);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['registered_credits'])) $this->registered_credits = $o['registered_credits'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->registered_credits)) $o['registered_credits'] = $this->registered_credits;
        return empty($o) ? new class(){} : $o;
    }
}

class StudentTransferCredentialTranscriptResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $course_name=null,
        /** @var string|null */
        public ?string $title=null,
        /** @var bool|null */
        public ?bool $is_advanced_standing=null,
        /** @var float|null */
        public ?float $credit_value=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['course_name'])) $this->course_name = $o['course_name'];
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['is_advanced_standing'])) $this->is_advanced_standing = $o['is_advanced_standing'];
        if (isset($o['credit_value'])) $this->credit_value = $o['credit_value'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->course_name)) $o['course_name'] = $this->course_name;
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->is_advanced_standing)) $o['is_advanced_standing'] = $this->is_advanced_standing;
        if (isset($this->credit_value)) $o['credit_value'] = $this->credit_value;
        return empty($o) ? new class(){} : $o;
    }
}

class StudentTransferCredentialsTranscriptResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $institution_name=null,
        /** @var array<StudentTransferCredentialTranscriptResponse>|null */
        public ?array $transferCredits=null
    ) {
    }

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

class TranscriptResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $first_name=null,
        /** @var string|null */
        public ?string $last_name=null,
        /** @var string|null */
        public ?string $middle_name=null,
        /** @var string|null */
        public ?string $override_name=null,
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $academic_level=null,
        /** @var DateTime */
        public DateTime $dob=new DateTime(),
        /** @var array<ExternalDegreeResponse>|null */
        public ?array $previous_degrees=null,
        /** @var array<StudentProgramTranscriptResponse>|null */
        public ?array $student_programs=null,
        /** @var array<RegentDegreeResponse>|null */
        public ?array $regent_degrees=null,
        /** @var array<StudentAcademicCredentialTranscriptResponse>|null */
        public ?array $student_academic_credentials=null,
        /** @var array<StudentTransferCredentialsTranscriptResponse>|null */
        public ?array $transfer_credentials=null,
        /** @var array<string>|null */
        public ?array $transcript_notes=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['first_name'])) $this->first_name = $o['first_name'];
        if (isset($o['last_name'])) $this->last_name = $o['last_name'];
        if (isset($o['middle_name'])) $this->middle_name = $o['middle_name'];
        if (isset($o['override_name'])) $this->override_name = $o['override_name'];
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['academic_level'])) $this->academic_level = $o['academic_level'];
        if (isset($o['dob'])) $this->dob = JsonConverters::from('DateTime', $o['dob']);
        if (isset($o['previous_degrees'])) $this->previous_degrees = JsonConverters::fromArray('ExternalDegreeResponse', $o['previous_degrees']);
        if (isset($o['student_programs'])) $this->student_programs = JsonConverters::fromArray('StudentProgramTranscriptResponse', $o['student_programs']);
        if (isset($o['regent_degrees'])) $this->regent_degrees = JsonConverters::fromArray('RegentDegreeResponse', $o['regent_degrees']);
        if (isset($o['student_academic_credentials'])) $this->student_academic_credentials = JsonConverters::fromArray('StudentAcademicCredentialTranscriptResponse', $o['student_academic_credentials']);
        if (isset($o['transfer_credentials'])) $this->transfer_credentials = JsonConverters::fromArray('StudentTransferCredentialsTranscriptResponse', $o['transfer_credentials']);
        if (isset($o['transcript_notes'])) $this->transcript_notes = JsonConverters::fromArray('string', $o['transcript_notes']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->first_name)) $o['first_name'] = $this->first_name;
        if (isset($this->last_name)) $o['last_name'] = $this->last_name;
        if (isset($this->middle_name)) $o['middle_name'] = $this->middle_name;
        if (isset($this->override_name)) $o['override_name'] = $this->override_name;
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->academic_level)) $o['academic_level'] = $this->academic_level;
        if (isset($this->dob)) $o['dob'] = JsonConverters::to('DateTime', $this->dob);
        if (isset($this->previous_degrees)) $o['previous_degrees'] = JsonConverters::toArray('ExternalDegreeResponse', $this->previous_degrees);
        if (isset($this->student_programs)) $o['student_programs'] = JsonConverters::toArray('StudentProgramTranscriptResponse', $this->student_programs);
        if (isset($this->regent_degrees)) $o['regent_degrees'] = JsonConverters::toArray('RegentDegreeResponse', $this->regent_degrees);
        if (isset($this->student_academic_credentials)) $o['student_academic_credentials'] = JsonConverters::toArray('StudentAcademicCredentialTranscriptResponse', $this->student_academic_credentials);
        if (isset($this->transfer_credentials)) $o['transfer_credentials'] = JsonConverters::toArray('StudentTransferCredentialsTranscriptResponse', $this->transfer_credentials);
        if (isset($this->transcript_notes)) $o['transcript_notes'] = JsonConverters::toArray('string', $this->transcript_notes);
        return empty($o) ? new class(){} : $o;
    }
}

class TranscriptRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $academic_level=null,
        /** @var bool|null */
        public ?bool $override_all_restrictions=null,
        /** @var bool|null */
        public ?bool $override_nonfinancial_restrictions=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['academic_level'])) $this->academic_level = $o['academic_level'];
        if (isset($o['override_all_restrictions'])) $this->override_all_restrictions = $o['override_all_restrictions'];
        if (isset($o['override_nonfinancial_restrictions'])) $this->override_nonfinancial_restrictions = $o['override_nonfinancial_restrictions'];
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->academic_level)) $o['academic_level'] = $this->academic_level;
        if (isset($this->override_all_restrictions)) $o['override_all_restrictions'] = $this->override_all_restrictions;
        if (isset($this->override_nonfinancial_restrictions)) $o['override_nonfinancial_restrictions'] = $this->override_nonfinancial_restrictions;
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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>