| Required permission: | ReadSectionGuest |
| POST | /Sections/Guest/{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 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 SectionGuestResponse implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $uuid=null,
/** @var string|null */
public ?string $course_name=null,
/** @var string|null */
public ?string $title=null,
/** @var string|null */
public ?string $term=null,
/** @var string|null */
public ?string $reporting_term=null,
/** @var array<PersonSimpleResponse>|null */
public ?array $guest_list=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['uuid'])) $this->uuid = $o['uuid'];
if (isset($o['course_name'])) $this->course_name = $o['course_name'];
if (isset($o['title'])) $this->title = $o['title'];
if (isset($o['term'])) $this->term = $o['term'];
if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
if (isset($o['guest_list'])) $this->guest_list = JsonConverters::fromArray('PersonSimpleResponse', $o['guest_list']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->uuid)) $o['uuid'] = $this->uuid;
if (isset($this->course_name)) $o['course_name'] = $this->course_name;
if (isset($this->title)) $o['title'] = $this->title;
if (isset($this->term)) $o['term'] = $this->term;
if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
if (isset($this->guest_list)) $o['guest_list'] = JsonConverters::toArray('PersonSimpleResponse', $this->guest_list);
return empty($o) ? new class(){} : $o;
}
}
class SectionGuestRequest 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;
}
}
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 /Sections/Guest/{uuid} 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
{
uuid: String,
course_name: String,
title: String,
term: String,
reporting_term: String,
guest_list:
[
{
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
}
]
}