regis

<back to all web services

RegistrationSummaryRequest

Requires Authentication
Required permission:ReadRegistrationAvailability
The following routes are available for this service:
POST/registration/summary
<?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 PersonSimpleResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var int */
        public int $regent_id=0,
        /** @var int|null */
        public ?int $ubc_id=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $regent_login=null,
        /** @var string|null */
        public ?string $first_name=null,
        /** @var string|null */
        public ?string $preferred_name=null,
        /** @var string|null */
        public ?string $middle_name=null,
        /** @var string|null */
        public ?string $last_name=null,
        /** @var string|null */
        public ?string $email=null,
        /** @var string|null */
        public ?string $phone_home=null,
        /** @var string|null */
        public ?string $phone_cell=null,
        /** @var string|null */
        public ?string $phone_bus=null,
        /** @var string|null */
        public ?string $addr1=null,
        /** @var string|null */
        public ?string $addr2=null,
        /** @var string|null */
        public ?string $city=null,
        /** @var string|null */
        public ?string $state=null,
        /** @var string|null */
        public ?string $country=null,
        /** @var string|null */
        public ?string $code=null,
        /** @var string|null */
        public ?string $citizenship=null,
        /** @var string|null */
        public ?string $citizenship_other=null,
        /** @var string|null */
        public ?string $permanent_resident=null,
        /** @var DateTime|null */
        public ?DateTime $dob=null,
        /** @var bool|null */
        public ?bool $is_student=null,
        /** @var bool|null */
        public ?bool $is_faculty=null,
        /** @var bool|null */
        public ?bool $is_vendor=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['ubc_id'])) $this->ubc_id = $o['ubc_id'];
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['regent_login'])) $this->regent_login = $o['regent_login'];
        if (isset($o['first_name'])) $this->first_name = $o['first_name'];
        if (isset($o['preferred_name'])) $this->preferred_name = $o['preferred_name'];
        if (isset($o['middle_name'])) $this->middle_name = $o['middle_name'];
        if (isset($o['last_name'])) $this->last_name = $o['last_name'];
        if (isset($o['email'])) $this->email = $o['email'];
        if (isset($o['phone_home'])) $this->phone_home = $o['phone_home'];
        if (isset($o['phone_cell'])) $this->phone_cell = $o['phone_cell'];
        if (isset($o['phone_bus'])) $this->phone_bus = $o['phone_bus'];
        if (isset($o['addr1'])) $this->addr1 = $o['addr1'];
        if (isset($o['addr2'])) $this->addr2 = $o['addr2'];
        if (isset($o['city'])) $this->city = $o['city'];
        if (isset($o['state'])) $this->state = $o['state'];
        if (isset($o['country'])) $this->country = $o['country'];
        if (isset($o['code'])) $this->code = $o['code'];
        if (isset($o['citizenship'])) $this->citizenship = $o['citizenship'];
        if (isset($o['citizenship_other'])) $this->citizenship_other = $o['citizenship_other'];
        if (isset($o['permanent_resident'])) $this->permanent_resident = $o['permanent_resident'];
        if (isset($o['dob'])) $this->dob = JsonConverters::from('DateTime', $o['dob']);
        if (isset($o['is_student'])) $this->is_student = $o['is_student'];
        if (isset($o['is_faculty'])) $this->is_faculty = $o['is_faculty'];
        if (isset($o['is_vendor'])) $this->is_vendor = $o['is_vendor'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->ubc_id)) $o['ubc_id'] = $this->ubc_id;
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->regent_login)) $o['regent_login'] = $this->regent_login;
        if (isset($this->first_name)) $o['first_name'] = $this->first_name;
        if (isset($this->preferred_name)) $o['preferred_name'] = $this->preferred_name;
        if (isset($this->middle_name)) $o['middle_name'] = $this->middle_name;
        if (isset($this->last_name)) $o['last_name'] = $this->last_name;
        if (isset($this->email)) $o['email'] = $this->email;
        if (isset($this->phone_home)) $o['phone_home'] = $this->phone_home;
        if (isset($this->phone_cell)) $o['phone_cell'] = $this->phone_cell;
        if (isset($this->phone_bus)) $o['phone_bus'] = $this->phone_bus;
        if (isset($this->addr1)) $o['addr1'] = $this->addr1;
        if (isset($this->addr2)) $o['addr2'] = $this->addr2;
        if (isset($this->city)) $o['city'] = $this->city;
        if (isset($this->state)) $o['state'] = $this->state;
        if (isset($this->country)) $o['country'] = $this->country;
        if (isset($this->code)) $o['code'] = $this->code;
        if (isset($this->citizenship)) $o['citizenship'] = $this->citizenship;
        if (isset($this->citizenship_other)) $o['citizenship_other'] = $this->citizenship_other;
        if (isset($this->permanent_resident)) $o['permanent_resident'] = $this->permanent_resident;
        if (isset($this->dob)) $o['dob'] = JsonConverters::to('DateTime', $this->dob);
        if (isset($this->is_student)) $o['is_student'] = $this->is_student;
        if (isset($this->is_faculty)) $o['is_faculty'] = $this->is_faculty;
        if (isset($this->is_vendor)) $o['is_vendor'] = $this->is_vendor;
        return empty($o) ? new class(){} : $o;
    }
}

class StudentAcademicCredentialSimpleResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $course_uuid=null,
        /** @var string|null */
        public ?string $course_name=null,
        /** @var string|null */
        public ?string $section_code=null,
        /** @var int|null */
        public ?int $section_id=null,
        /** @var string|null */
        public ?string $term=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var string|null */
        public ?string $title=null,
        /** @var float|null */
        public ?float $amount=null,
        /** @var bool|null */
        public ?bool $is_audit=null,
        /** @var bool|null */
        public ?bool $is_pass_fail=null,
        /** @var bool|null */
        public ?bool $is_graded=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['course_uuid'])) $this->course_uuid = $o['course_uuid'];
        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['section_id'])) $this->section_id = $o['section_id'];
        if (isset($o['term'])) $this->term = $o['term'];
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['amount'])) $this->amount = $o['amount'];
        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['is_graded'])) $this->is_graded = $o['is_graded'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->course_uuid)) $o['course_uuid'] = $this->course_uuid;
        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->section_id)) $o['section_id'] = $this->section_id;
        if (isset($this->term)) $o['term'] = $this->term;
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->amount)) $o['amount'] = $this->amount;
        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->is_graded)) $o['is_graded'] = $this->is_graded;
        return empty($o) ? new class(){} : $o;
    }
}

class StudentAcademicCredentialByReportingTermSimpleResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $reportingTerm=null,
        /** @var float */
        public float $onlineCreditsAttempted=0.0,
        /** @var float */
        public float $onlineAuditsAttempted=0.0,
        /** @var array<StudentAcademicCredentialSimpleResponse>|null */
        public ?array $studentAcademicCredentialSimpleResponse=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['reportingTerm'])) $this->reportingTerm = $o['reportingTerm'];
        if (isset($o['onlineCreditsAttempted'])) $this->onlineCreditsAttempted = $o['onlineCreditsAttempted'];
        if (isset($o['onlineAuditsAttempted'])) $this->onlineAuditsAttempted = $o['onlineAuditsAttempted'];
        if (isset($o['studentAcademicCredentialSimpleResponse'])) $this->studentAcademicCredentialSimpleResponse = JsonConverters::fromArray('StudentAcademicCredentialSimpleResponse', $o['studentAcademicCredentialSimpleResponse']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->reportingTerm)) $o['reportingTerm'] = $this->reportingTerm;
        if (isset($this->onlineCreditsAttempted)) $o['onlineCreditsAttempted'] = $this->onlineCreditsAttempted;
        if (isset($this->onlineAuditsAttempted)) $o['onlineAuditsAttempted'] = $this->onlineAuditsAttempted;
        if (isset($this->studentAcademicCredentialSimpleResponse)) $o['studentAcademicCredentialSimpleResponse'] = JsonConverters::toArray('StudentAcademicCredentialSimpleResponse', $this->studentAcademicCredentialSimpleResponse);
        return empty($o) ? new class(){} : $o;
    }
}

class RegistrationDocumentResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $first_name=null,
        /** @var string|null */
        public ?string $last_name=null,
        /** @var string|null */
        public ?string $gender=null,
        /** @var string|null */
        public ?string $email=null,
        /** @var string|null */
        public ?string $program=null,
        /** @var string|null */
        public ?string $concentration=null,
        /** @var string|null */
        public ?string $section_uuid=null,
        /** @var string|null */
        public ?string $course_name=null,
        /** @var string|null */
        public ?string $course_title=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var string|null */
        public ?string $document_code=null,
        /** @var string|null */
        public ?string $document_json=null,
        /** @var string|null */
        public ?string $document_name=null,
        /** @var string|null */
        public ?string $document_description=null,
        /** @var DateTime|null */
        public ?DateTime $added_date=null,
        /** @var DateTime|null */
        public ?DateTime $changed_date=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        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['gender'])) $this->gender = $o['gender'];
        if (isset($o['email'])) $this->email = $o['email'];
        if (isset($o['program'])) $this->program = $o['program'];
        if (isset($o['concentration'])) $this->concentration = $o['concentration'];
        if (isset($o['section_uuid'])) $this->section_uuid = $o['section_uuid'];
        if (isset($o['course_name'])) $this->course_name = $o['course_name'];
        if (isset($o['course_title'])) $this->course_title = $o['course_title'];
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['document_code'])) $this->document_code = $o['document_code'];
        if (isset($o['document_json'])) $this->document_json = $o['document_json'];
        if (isset($o['document_name'])) $this->document_name = $o['document_name'];
        if (isset($o['document_description'])) $this->document_description = $o['document_description'];
        if (isset($o['added_date'])) $this->added_date = JsonConverters::from('DateTime', $o['added_date']);
        if (isset($o['changed_date'])) $this->changed_date = JsonConverters::from('DateTime', $o['changed_date']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        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->gender)) $o['gender'] = $this->gender;
        if (isset($this->email)) $o['email'] = $this->email;
        if (isset($this->program)) $o['program'] = $this->program;
        if (isset($this->concentration)) $o['concentration'] = $this->concentration;
        if (isset($this->section_uuid)) $o['section_uuid'] = $this->section_uuid;
        if (isset($this->course_name)) $o['course_name'] = $this->course_name;
        if (isset($this->course_title)) $o['course_title'] = $this->course_title;
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->document_code)) $o['document_code'] = $this->document_code;
        if (isset($this->document_json)) $o['document_json'] = $this->document_json;
        if (isset($this->document_name)) $o['document_name'] = $this->document_name;
        if (isset($this->document_description)) $o['document_description'] = $this->document_description;
        if (isset($this->added_date)) $o['added_date'] = JsonConverters::to('DateTime', $this->added_date);
        if (isset($this->changed_date)) $o['changed_date'] = JsonConverters::to('DateTime', $this->changed_date);
        return empty($o) ? new class(){} : $o;
    }
}

class ProvisionalRegistrationResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var int|null */
        public ?int $regent_id=null,
        /** @var string|null */
        public ?string $student_name=null,
        /** @var string|null */
        public ?string $email=null,
        /** @var string|null */
        public ?string $section_uuid=null,
        /** @var string|null */
        public ?string $student_section_uuid=null,
        /** @var string|null */
        public ?string $course_name=null,
        /** @var string|null */
        public ?string $section_code=null,
        /** @var string|null */
        public ?string $title=null,
        /** @var string|null */
        public ?string $term=null,
        /** @var float */
        public float $amount=0.0,
        /** @var bool|null */
        public ?bool $is_audit=null,
        /** @var bool|null */
        public ?bool $is_waitlist=null,
        /** @var bool|null */
        public ?bool $is_missing_requisites=null,
        /** @var bool|null */
        public ?bool $is_other_restriction=null,
        /** @var array<RegistrationDocumentResponse>|null */
        public ?array $documents=null,
        /** @var DateTime */
        public DateTime $requested_date=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['student_name'])) $this->student_name = $o['student_name'];
        if (isset($o['email'])) $this->email = $o['email'];
        if (isset($o['section_uuid'])) $this->section_uuid = $o['section_uuid'];
        if (isset($o['student_section_uuid'])) $this->student_section_uuid = $o['student_section_uuid'];
        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['title'])) $this->title = $o['title'];
        if (isset($o['term'])) $this->term = $o['term'];
        if (isset($o['amount'])) $this->amount = $o['amount'];
        if (isset($o['is_audit'])) $this->is_audit = $o['is_audit'];
        if (isset($o['is_waitlist'])) $this->is_waitlist = $o['is_waitlist'];
        if (isset($o['is_missing_requisites'])) $this->is_missing_requisites = $o['is_missing_requisites'];
        if (isset($o['is_other_restriction'])) $this->is_other_restriction = $o['is_other_restriction'];
        if (isset($o['documents'])) $this->documents = JsonConverters::fromArray('RegistrationDocumentResponse', $o['documents']);
        if (isset($o['requested_date'])) $this->requested_date = JsonConverters::from('DateTime', $o['requested_date']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->student_name)) $o['student_name'] = $this->student_name;
        if (isset($this->email)) $o['email'] = $this->email;
        if (isset($this->section_uuid)) $o['section_uuid'] = $this->section_uuid;
        if (isset($this->student_section_uuid)) $o['student_section_uuid'] = $this->student_section_uuid;
        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->title)) $o['title'] = $this->title;
        if (isset($this->term)) $o['term'] = $this->term;
        if (isset($this->amount)) $o['amount'] = $this->amount;
        if (isset($this->is_audit)) $o['is_audit'] = $this->is_audit;
        if (isset($this->is_waitlist)) $o['is_waitlist'] = $this->is_waitlist;
        if (isset($this->is_missing_requisites)) $o['is_missing_requisites'] = $this->is_missing_requisites;
        if (isset($this->is_other_restriction)) $o['is_other_restriction'] = $this->is_other_restriction;
        if (isset($this->documents)) $o['documents'] = JsonConverters::toArray('RegistrationDocumentResponse', $this->documents);
        if (isset($this->requested_date)) $o['requested_date'] = JsonConverters::to('DateTime', $this->requested_date);
        return empty($o) ? new class(){} : $o;
    }
}

class ProvisionalRegistrationsForStudentResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var array<ProvisionalRegistrationResponse>|null */
        public ?array $provisional_registrations=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['provisional_registrations'])) $this->provisional_registrations = JsonConverters::fromArray('ProvisionalRegistrationResponse', $o['provisional_registrations']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->provisional_registrations)) $o['provisional_registrations'] = JsonConverters::toArray('ProvisionalRegistrationResponse', $this->provisional_registrations);
        return empty($o) ? new class(){} : $o;
    }
}

class RegistrationSummaryResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var bool|null */
        public ?bool $is_missing_tax_number=null,
        /** @var PersonSimpleResponse|null */
        public ?PersonSimpleResponse $person=null,
        /** @var array<StudentAcademicCredentialByReportingTermSimpleResponse>|null */
        public ?array $registrations=null,
        /** @var ProvisionalRegistrationsForStudentResponse|null */
        public ?ProvisionalRegistrationsForStudentResponse $provisional_registrations=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['is_missing_tax_number'])) $this->is_missing_tax_number = $o['is_missing_tax_number'];
        if (isset($o['person'])) $this->person = JsonConverters::from('PersonSimpleResponse', $o['person']);
        if (isset($o['registrations'])) $this->registrations = JsonConverters::fromArray('StudentAcademicCredentialByReportingTermSimpleResponse', $o['registrations']);
        if (isset($o['provisional_registrations'])) $this->provisional_registrations = JsonConverters::from('ProvisionalRegistrationsForStudentResponse', $o['provisional_registrations']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->is_missing_tax_number)) $o['is_missing_tax_number'] = $this->is_missing_tax_number;
        if (isset($this->person)) $o['person'] = JsonConverters::to('PersonSimpleResponse', $this->person);
        if (isset($this->registrations)) $o['registrations'] = JsonConverters::toArray('StudentAcademicCredentialByReportingTermSimpleResponse', $this->registrations);
        if (isset($this->provisional_registrations)) $o['provisional_registrations'] = JsonConverters::to('ProvisionalRegistrationsForStudentResponse', $this->provisional_registrations);
        return empty($o) ? new class(){} : $o;
    }
}

class RegistrationSummaryRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $from_this_term=null
    ) {
    }

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

PHP RegistrationSummaryRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /registration/summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String","from_this_term":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","is_missing_tax_number":false,"person":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"ubc_id":0,"uuid":"String","regent_login":"String","first_name":"String","preferred_name":"String","middle_name":"String","last_name":"String","email":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","dob":"0001-01-01T00:00:00.0000000","is_student":false,"is_faculty":false,"is_vendor":false},"registrations":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"reportingTerm":"String","onlineCreditsAttempted":0,"onlineAuditsAttempted":0,"studentAcademicCredentialSimpleResponse":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"course_uuid":"String","course_name":"String","section_code":"String","section_id":0,"term":"String","reporting_term":"String","title":"String","amount":0,"is_audit":false,"is_pass_fail":false,"is_graded":false}]}],"provisional_registrations":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","provisional_registrations":[{"uuid":"String","regent_id":0,"student_name":"String","email":"String","section_uuid":"String","student_section_uuid":"String","course_name":"String","section_code":"String","title":"String","term":"String","amount":0,"is_audit":false,"is_waitlist":false,"is_missing_requisites":false,"is_other_restriction":false,"documents":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"requested_date":"0001-01-01T00:00:00.0000000"}]}}