regis

<back to all web services

BioHistoryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/bio/history
<?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 BioResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=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 string|null */
        public ?string $birth_name=null,
        /** @var string|null */
        public ?string $prefix=null,
        /** @var DateTime|null */
        public ?DateTime $dob=null,
        /** @var string|null */
        public ?string $citizenship=null,
        /** @var string|null */
        public ?string $citizenship_code=null,
        /** @var string|null */
        public ?string $citizenship_other=null,
        /** @var string|null */
        public ?string $permanent_resident=null,
        /** @var string|null */
        public ?string $citizenship_other_code=null,
        /** @var string|null */
        public ?string $permanent_resident_code=null,
        /** @var string|null */
        public ?string $gender=null,
        /** @var string|null */
        public ?string $gender_code=null,
        /** @var string|null */
        public ?string $marital_status=null,
        /** @var string|null */
        public ?string $marital_status_code=null,
        /** @var DateTime|null */
        public ?DateTime $deceased_date=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['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['birth_name'])) $this->birth_name = $o['birth_name'];
        if (isset($o['prefix'])) $this->prefix = $o['prefix'];
        if (isset($o['dob'])) $this->dob = JsonConverters::from('DateTime', $o['dob']);
        if (isset($o['citizenship'])) $this->citizenship = $o['citizenship'];
        if (isset($o['citizenship_code'])) $this->citizenship_code = $o['citizenship_code'];
        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['citizenship_other_code'])) $this->citizenship_other_code = $o['citizenship_other_code'];
        if (isset($o['permanent_resident_code'])) $this->permanent_resident_code = $o['permanent_resident_code'];
        if (isset($o['gender'])) $this->gender = $o['gender'];
        if (isset($o['gender_code'])) $this->gender_code = $o['gender_code'];
        if (isset($o['marital_status'])) $this->marital_status = $o['marital_status'];
        if (isset($o['marital_status_code'])) $this->marital_status_code = $o['marital_status_code'];
        if (isset($o['deceased_date'])) $this->deceased_date = JsonConverters::from('DateTime', $o['deceased_date']);
        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->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->birth_name)) $o['birth_name'] = $this->birth_name;
        if (isset($this->prefix)) $o['prefix'] = $this->prefix;
        if (isset($this->dob)) $o['dob'] = JsonConverters::to('DateTime', $this->dob);
        if (isset($this->citizenship)) $o['citizenship'] = $this->citizenship;
        if (isset($this->citizenship_code)) $o['citizenship_code'] = $this->citizenship_code;
        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->citizenship_other_code)) $o['citizenship_other_code'] = $this->citizenship_other_code;
        if (isset($this->permanent_resident_code)) $o['permanent_resident_code'] = $this->permanent_resident_code;
        if (isset($this->gender)) $o['gender'] = $this->gender;
        if (isset($this->gender_code)) $o['gender_code'] = $this->gender_code;
        if (isset($this->marital_status)) $o['marital_status'] = $this->marital_status;
        if (isset($this->marital_status_code)) $o['marital_status_code'] = $this->marital_status_code;
        if (isset($this->deceased_date)) $o['deceased_date'] = JsonConverters::to('DateTime', $this->deceased_date);
        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 BioHistoryResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var int */
        public int $regent_id=0,
        /** @var array<BioResponse>|null */
        public ?array $bios=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['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['bios'])) $this->bios = JsonConverters::fromArray('BioResponse', $o['bios']);
    }
    
    /** @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->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->bios)) $o['bios'] = JsonConverters::toArray('BioResponse', $this->bios);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

HTTP + JSV

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

POST /admissions/{uuid}/bio/history 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
		}
	},
	uuid: String,
	regent_id: 0,
	bios: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			first_name: String,
			middle_name: String,
			last_name: String,
			preferred_name: String,
			birth_name: String,
			prefix: String,
			dob: 0001-01-01,
			citizenship: String,
			citizenship_code: String,
			citizenship_other: String,
			permanent_resident: String,
			citizenship_other_code: String,
			permanent_resident_code: String,
			gender: String,
			gender_code: String,
			marital_status: String,
			marital_status_code: String,
			deceased_date: 0001-01-01,
			added_by: String,
			added_date: 0001-01-01,
			changed_by: String,
			changed_date: 0001-01-01
		}
	]
}