| Required role: | REGISUserRole |
| POST | /Academic/Institution/{institution_id}/Students |
|---|
<?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 InstitutionResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var int */
public int $institution_id=0,
/** @var string|null */
public ?string $institution_name=null,
/** @var string|null */
public ?string $institution_previous_names=null,
/** @var string|null */
public ?string $institution_other_names=null,
/** @var string|null */
public ?string $institution_type=null,
/** @var string|null */
public ?string $accreditation_status=null,
/** @var string|null */
public ?string $accreditation_status_notes=null,
/** @var array<string>|null */
public ?array $related_institutions=null,
/** @var DateTime|null */
public ?DateTime $accreditation_status_changed_date=null,
/** @var string|null */
public ?string $gpa_conversion=null,
/** @var string|null */
public ?string $credit_hour_conversion=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 $zip=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
if (isset($o['institution_id'])) $this->institution_id = $o['institution_id'];
if (isset($o['institution_name'])) $this->institution_name = $o['institution_name'];
if (isset($o['institution_previous_names'])) $this->institution_previous_names = $o['institution_previous_names'];
if (isset($o['institution_other_names'])) $this->institution_other_names = $o['institution_other_names'];
if (isset($o['institution_type'])) $this->institution_type = $o['institution_type'];
if (isset($o['accreditation_status'])) $this->accreditation_status = $o['accreditation_status'];
if (isset($o['accreditation_status_notes'])) $this->accreditation_status_notes = $o['accreditation_status_notes'];
if (isset($o['related_institutions'])) $this->related_institutions = JsonConverters::fromArray('string', $o['related_institutions']);
if (isset($o['accreditation_status_changed_date'])) $this->accreditation_status_changed_date = JsonConverters::from('DateTime', $o['accreditation_status_changed_date']);
if (isset($o['gpa_conversion'])) $this->gpa_conversion = $o['gpa_conversion'];
if (isset($o['credit_hour_conversion'])) $this->credit_hour_conversion = $o['credit_hour_conversion'];
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['zip'])) $this->zip = $o['zip'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
if (isset($this->institution_id)) $o['institution_id'] = $this->institution_id;
if (isset($this->institution_name)) $o['institution_name'] = $this->institution_name;
if (isset($this->institution_previous_names)) $o['institution_previous_names'] = $this->institution_previous_names;
if (isset($this->institution_other_names)) $o['institution_other_names'] = $this->institution_other_names;
if (isset($this->institution_type)) $o['institution_type'] = $this->institution_type;
if (isset($this->accreditation_status)) $o['accreditation_status'] = $this->accreditation_status;
if (isset($this->accreditation_status_notes)) $o['accreditation_status_notes'] = $this->accreditation_status_notes;
if (isset($this->related_institutions)) $o['related_institutions'] = JsonConverters::toArray('string', $this->related_institutions);
if (isset($this->accreditation_status_changed_date)) $o['accreditation_status_changed_date'] = JsonConverters::to('DateTime', $this->accreditation_status_changed_date);
if (isset($this->gpa_conversion)) $o['gpa_conversion'] = $this->gpa_conversion;
if (isset($this->credit_hour_conversion)) $o['credit_hour_conversion'] = $this->credit_hour_conversion;
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->zip)) $o['zip'] = $this->zip;
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 StudentTransferCredentialResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var string|null */
public ?string $uuid=null,
/** @var string|null */
public ?string $stran_uuid=null,
/** @var string|null */
public ?string $course_name=null,
/** @var string|null */
public ?string $title=null,
/** @var float|null */
public ?float $credit_value=null,
/** @var bool|null */
public ?bool $is_advanced_standing=null,
/** @var int */
public int $equivalent_id=0,
/** @var int */
public int $institution_id=0,
/** @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['stran_uuid'])) $this->stran_uuid = $o['stran_uuid'];
if (isset($o['course_name'])) $this->course_name = $o['course_name'];
if (isset($o['title'])) $this->title = $o['title'];
if (isset($o['credit_value'])) $this->credit_value = $o['credit_value'];
if (isset($o['is_advanced_standing'])) $this->is_advanced_standing = $o['is_advanced_standing'];
if (isset($o['equivalent_id'])) $this->equivalent_id = $o['equivalent_id'];
if (isset($o['institution_id'])) $this->institution_id = $o['institution_id'];
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->stran_uuid)) $o['stran_uuid'] = $this->stran_uuid;
if (isset($this->course_name)) $o['course_name'] = $this->course_name;
if (isset($this->title)) $o['title'] = $this->title;
if (isset($this->credit_value)) $o['credit_value'] = $this->credit_value;
if (isset($this->is_advanced_standing)) $o['is_advanced_standing'] = $this->is_advanced_standing;
if (isset($this->equivalent_id)) $o['equivalent_id'] = $this->equivalent_id;
if (isset($this->institution_id)) $o['institution_id'] = $this->institution_id;
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 StudentTransferCredentialPackageResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var int */
public int $equivalent_id=0,
/** @var bool|null */
public ?bool $is_advanced_standing=null,
/** @var InstitutionResponse|null */
public ?InstitutionResponse $institution=null,
/** @var array<StudentAcademicCredentialResponse>|null */
public ?array $studentAcademicCredentials=null,
/** @var array<StudentTransferCredentialResponse>|null */
public ?array $studentTransferCredentials=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
if (isset($o['equivalent_id'])) $this->equivalent_id = $o['equivalent_id'];
if (isset($o['is_advanced_standing'])) $this->is_advanced_standing = $o['is_advanced_standing'];
if (isset($o['institution'])) $this->institution = JsonConverters::from('InstitutionResponse', $o['institution']);
if (isset($o['studentAcademicCredentials'])) $this->studentAcademicCredentials = JsonConverters::fromArray('StudentAcademicCredentialResponse', $o['studentAcademicCredentials']);
if (isset($o['studentTransferCredentials'])) $this->studentTransferCredentials = JsonConverters::fromArray('StudentTransferCredentialResponse', $o['studentTransferCredentials']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
if (isset($this->equivalent_id)) $o['equivalent_id'] = $this->equivalent_id;
if (isset($this->is_advanced_standing)) $o['is_advanced_standing'] = $this->is_advanced_standing;
if (isset($this->institution)) $o['institution'] = JsonConverters::to('InstitutionResponse', $this->institution);
if (isset($this->studentAcademicCredentials)) $o['studentAcademicCredentials'] = JsonConverters::toArray('StudentAcademicCredentialResponse', $this->studentAcademicCredentials);
if (isset($this->studentTransferCredentials)) $o['studentTransferCredentials'] = JsonConverters::toArray('StudentTransferCredentialResponse', $this->studentTransferCredentials);
return empty($o) ? new class(){} : $o;
}
}
class StudentTransferCredentialsResponse 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<StudentTransferCredentialPackageResponse>|null */
public ?array $studentTransferCredentialPackage=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['studentTransferCredentialPackage'])) $this->studentTransferCredentialPackage = JsonConverters::fromArray('StudentTransferCredentialPackageResponse', $o['studentTransferCredentialPackage']);
}
/** @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->studentTransferCredentialPackage)) $o['studentTransferCredentialPackage'] = JsonConverters::toArray('StudentTransferCredentialPackageResponse', $this->studentTransferCredentialPackage);
return empty($o) ? new class(){} : $o;
}
}
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 StudentProgramSimpleResponse 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 int */
public int $program_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 $start_date=null,
/** @var DateTime|null */
public ?DateTime $end_date=null,
/** @var string|null */
public ?string $catalog=null,
/** @var bool|null */
public ?bool $is_active=null,
/** @var bool|null */
public ?bool $is_graduated=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['program_id'])) $this->program_id = $o['program_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['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['catalog'])) $this->catalog = $o['catalog'];
if (isset($o['is_active'])) $this->is_active = $o['is_active'];
if (isset($o['is_graduated'])) $this->is_graduated = $o['is_graduated'];
}
/** @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->program_id)) $o['program_id'] = $this->program_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->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->catalog)) $o['catalog'] = $this->catalog;
if (isset($this->is_active)) $o['is_active'] = $this->is_active;
if (isset($this->is_graduated)) $o['is_graduated'] = $this->is_graduated;
return empty($o) ? new class(){} : $o;
}
}
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 ExternalDegreesAdminResponse implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $degree_code=null,
/** @var string|null */
public ?string $degree_name=null,
/** @var string|null */
public ?string $degree_type=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['degree_code'])) $this->degree_code = $o['degree_code'];
if (isset($o['degree_name'])) $this->degree_name = $o['degree_name'];
if (isset($o['degree_type'])) $this->degree_type = $o['degree_type'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->degree_code)) $o['degree_code'] = $this->degree_code;
if (isset($this->degree_name)) $o['degree_name'] = $this->degree_name;
if (isset($this->degree_type)) $o['degree_type'] = $this->degree_type;
return empty($o) ? new class(){} : $o;
}
}
class ExternalDegreesResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var PersonSimpleResponse|null */
public ?PersonSimpleResponse $person=null,
/** @var float|null */
public ?float $gpa=null,
/** @var array<StudentProgramSimpleResponse>|null */
public ?array $student_programs=null,
/** @var array<ExternalDegreeResponse>|null */
public ?array $degrees=null,
/** @var array<ExternalDegreesAdminResponse>|null */
public ?array $valid_degrees=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
if (isset($o['person'])) $this->person = JsonConverters::from('PersonSimpleResponse', $o['person']);
if (isset($o['gpa'])) $this->gpa = $o['gpa'];
if (isset($o['student_programs'])) $this->student_programs = JsonConverters::fromArray('StudentProgramSimpleResponse', $o['student_programs']);
if (isset($o['degrees'])) $this->degrees = JsonConverters::fromArray('ExternalDegreeResponse', $o['degrees']);
if (isset($o['valid_degrees'])) $this->valid_degrees = JsonConverters::fromArray('ExternalDegreesAdminResponse', $o['valid_degrees']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
if (isset($this->person)) $o['person'] = JsonConverters::to('PersonSimpleResponse', $this->person);
if (isset($this->gpa)) $o['gpa'] = $this->gpa;
if (isset($this->student_programs)) $o['student_programs'] = JsonConverters::toArray('StudentProgramSimpleResponse', $this->student_programs);
if (isset($this->degrees)) $o['degrees'] = JsonConverters::toArray('ExternalDegreeResponse', $this->degrees);
if (isset($this->valid_degrees)) $o['valid_degrees'] = JsonConverters::toArray('ExternalDegreesAdminResponse', $this->valid_degrees);
return empty($o) ? new class(){} : $o;
}
}
class InstitutionStudentsResponse extends InstitutionResponse implements JsonSerializable
{
/**
* @param ResponseStatus|null $responseStatus
* @param int $institution_id
* @param string|null $institution_name
* @param string|null $institution_previous_names
* @param string|null $institution_other_names
* @param string|null $institution_type
* @param string|null $accreditation_status
* @param string|null $accreditation_status_notes
* @param array<string>|null $related_institutions
* @param DateTime|null $accreditation_status_changed_date
* @param string|null $gpa_conversion
* @param string|null $credit_hour_conversion
* @param string|null $addr1
* @param string|null $addr2
* @param string|null $city
* @param string|null $state
* @param string|null $country
* @param string|null $zip
*/
public function __construct(
?ResponseStatus $responseStatus=null,
int $institution_id=0,
?string $institution_name=null,
?string $institution_previous_names=null,
?string $institution_other_names=null,
?string $institution_type=null,
?string $accreditation_status=null,
?string $accreditation_status_notes=null,
?array $related_institutions=null,
?DateTime $accreditation_status_changed_date=null,
?string $gpa_conversion=null,
?string $credit_hour_conversion=null,
?string $addr1=null,
?string $addr2=null,
?string $city=null,
?string $state=null,
?string $country=null,
?string $zip=null,
/** @var array<StudentTransferCredentialsResponse>|null */
public ?array $student_transfer_credentials=null,
/** @var array<ExternalDegreesResponse>|null */
public ?array $student_previous_degrees=null
) {
parent::__construct($responseStatus,$institution_id,$institution_name,$institution_previous_names,$institution_other_names,$institution_type,$accreditation_status,$accreditation_status_notes,$related_institutions,$accreditation_status_changed_date,$gpa_conversion,$credit_hour_conversion,$addr1,$addr2,$city,$state,$country,$zip);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['student_transfer_credentials'])) $this->student_transfer_credentials = JsonConverters::fromArray('StudentTransferCredentialsResponse', $o['student_transfer_credentials']);
if (isset($o['student_previous_degrees'])) $this->student_previous_degrees = JsonConverters::fromArray('ExternalDegreesResponse', $o['student_previous_degrees']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->student_transfer_credentials)) $o['student_transfer_credentials'] = JsonConverters::toArray('StudentTransferCredentialsResponse', $this->student_transfer_credentials);
if (isset($this->student_previous_degrees)) $o['student_previous_degrees'] = JsonConverters::toArray('ExternalDegreesResponse', $this->student_previous_degrees);
return empty($o) ? new class(){} : $o;
}
}
class InstitutionStudentsRequest implements JsonSerializable
{
public function __construct(
/** @var int */
public int $institution_id=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['institution_id'])) $this->institution_id = $o['institution_id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->institution_id)) $o['institution_id'] = $this->institution_id;
return empty($o) ? new class(){} : $o;
}
}
PHP InstitutionStudentsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Academic/Institution/{institution_id}/Students HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"institution_id":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"student_transfer_credentials":[{"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","studentTransferCredentialPackage":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"equivalent_id":0,"is_advanced_standing":false,"institution":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"institution_id":0,"institution_name":"String","institution_previous_names":"String","institution_other_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","related_institutions":["String"],"accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","zip":"String"},"studentAcademicCredentials":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","stac_uuid":"String","section_id":0,"course_name":"String","section_code":"String","subject":"String","course_level":0,"title":"String","pretty_title":"String","location":"String","is_audio":false,"is_oncampus":false,"credit_value":0,"audit_value":0,"is_audit":false,"is_pass_fail":false,"grade":"String","is_grade_final":false,"gpa_credits":0,"grade_points":0,"academic_level":"String","printed_comments":"String","term":"String","reporting_term":"String","reporting_year":0,"current_status":"String","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}],"studentTransferCredentials":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","stran_uuid":"String","course_name":"String","title":"String","credit_value":0,"is_advanced_standing":false,"equivalent_id":0,"institution_id":0,"added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}]}]}],"student_previous_degrees":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"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},"gpa":0,"student_programs":[{"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","program_id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","catalog":"String","is_active":false,"is_graduated":false}],"degrees":[{"id":0,"institution_id":0,"degree_name":"String","degree_override_name":"String","institution_name":"String","graduation_month":"String","start_year":0,"end_year":0,"is_only_in_d365":false}],"valid_degrees":[{"degree_code":"String","degree_name":"String","degree_type":"String"}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"institution_id":0,"institution_name":"String","institution_previous_names":"String","institution_other_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","related_institutions":["String"],"accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","zip":"String"}