regis

PersonSideBarRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/person/{uuid}/sidebar

<?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 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 PersonSideBarResponse 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 $regent_login=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $first_name=null,
        /** @var string|null */
        public ?string $middle_name=null,
        /** @var string|null */
        public ?string $last_name=null,
        /** @var string|null */
        public ?string $preferred_name=null,
        /** @var DateTime|null */
        public ?DateTime $dob=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 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 $code=null,
        /** @var string|null */
        public ?string $country=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 $imageBase64=null,
        /** @var string|null */
        public ?string $tax_number=null,
        /** @var array<StudentProgramSimpleResponse>|null */
        public ?array $programs=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['regent_login'])) $this->regent_login = $o['regent_login'];
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['first_name'])) $this->first_name = $o['first_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['preferred_name'])) $this->preferred_name = $o['preferred_name'];
        if (isset($o['dob'])) $this->dob = JsonConverters::from('DateTime', $o['dob']);
        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['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['code'])) $this->code = $o['code'];
        if (isset($o['country'])) $this->country = $o['country'];
        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['imageBase64'])) $this->imageBase64 = $o['imageBase64'];
        if (isset($o['tax_number'])) $this->tax_number = $o['tax_number'];
        if (isset($o['programs'])) $this->programs = JsonConverters::fromArray('StudentProgramSimpleResponse', $o['programs']);
    }
    
    /** @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->regent_login)) $o['regent_login'] = $this->regent_login;
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->first_name)) $o['first_name'] = $this->first_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->preferred_name)) $o['preferred_name'] = $this->preferred_name;
        if (isset($this->dob)) $o['dob'] = JsonConverters::to('DateTime', $this->dob);
        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->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->code)) $o['code'] = $this->code;
        if (isset($this->country)) $o['country'] = $this->country;
        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->imageBase64)) $o['imageBase64'] = $this->imageBase64;
        if (isset($this->tax_number)) $o['tax_number'] = $this->tax_number;
        if (isset($this->programs)) $o['programs'] = JsonConverters::toArray('StudentProgramSimpleResponse', $this->programs);
        return empty($o) ? new class(){} : $o;
    }
}

class PersonSideBarRequest 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 PersonSideBarRequest DTOs

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

HTTP + XML

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

POST /person/{uuid}/sidebar HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PersonSideBarRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</PersonSideBarRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PersonSideBarResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <citizenship>String</citizenship>
  <citizenship_other>String</citizenship_other>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <dob>0001-01-01T00:00:00</dob>
  <email>String</email>
  <first_name>String</first_name>
  <imageBase64>String</imageBase64>
  <last_name>String</last_name>
  <middle_name>String</middle_name>
  <permanent_resident>String</permanent_resident>
  <phone_bus>String</phone_bus>
  <phone_cell>String</phone_cell>
  <phone_home>String</phone_home>
  <preferred_name>String</preferred_name>
  <programs>
    <StudentProgramSimpleResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <catalog>String</catalog>
      <concentration_code>String</concentration_code>
      <concentration_name>String</concentration_name>
      <end_date>0001-01-01T00:00:00</end_date>
      <is_active>false</is_active>
      <is_graduated>false</is_graduated>
      <program_code>String</program_code>
      <program_id>0</program_id>
      <program_name>String</program_name>
      <regent_id>0</regent_id>
      <start_date>0001-01-01T00:00:00</start_date>
      <uuid>String</uuid>
    </StudentProgramSimpleResponse>
  </programs>
  <regent_id>0</regent_id>
  <regent_login>String</regent_login>
  <state>String</state>
  <tax_number>String</tax_number>
  <ubc_id>0</ubc_id>
  <uuid>String</uuid>
</PersonSideBarResponse>