| Required permission: | ReadExternalDegrees |
| POST | /Academic/{uuid}/ExternalDegrees |
|---|
<?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 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 ExternalDegreesRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $uuid=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['uuid'])) $this->uuid = $o['uuid'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->uuid)) $o['uuid'] = $this->uuid;
return empty($o) ? new class(){} : $o;
}
}
PHP ExternalDegreesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Academic/{uuid}/ExternalDegrees HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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-01,
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-01,
end_date: 0001-01-01,
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
}
]
}