regis

<back to all web services

AddressAndBioUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/person/{uuid}/addressandbio/update
<?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 AddressAndBioUpdateResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var bool|null */
        public ?bool $update_success=null,
        /** @var array<string>|null */
        public ?array $messages=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['update_success'])) $this->update_success = $o['update_success'];
        if (isset($o['messages'])) $this->messages = JsonConverters::fromArray('string', $o['messages']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->update_success)) $o['update_success'] = $this->update_success;
        if (isset($this->messages)) $o['messages'] = JsonConverters::toArray('string', $this->messages);
        return empty($o) ? new class(){} : $o;
    }
}

class AddressAndBioUpdateRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var int|null */
        public ?int $spouse_regent_id=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 $addr1=null,
        /** @var string|null */
        public ?string $addr2=null,
        /** @var string|null */
        public ?string $country=null,
        /** @var string|null */
        public ?string $state=null,
        /** @var string|null */
        public ?string $city=null,
        /** @var string|null */
        public ?string $code=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 $email=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_other=null,
        /** @var string|null */
        public ?string $permanent_resident=null,
        /** @var string|null */
        public ?string $denomination=null,
        /** @var string|null */
        public ?string $occupation=null,
        /** @var string|null */
        public ?string $ethnicity=null,
        /** @var string|null */
        public ?string $gender=null,
        /** @var string|null */
        public ?string $marital_status=null,
        /** @var DateTime|null */
        public ?DateTime $deceased_date=null,
        /** @var string|null */
        public ?string $tax_number=null,
        /** @var bool|null */
        public ?bool $update_re_and_sugar=null,
        /** @var string|null */
        public ?string $regent_title=null,
        /** @var string|null */
        public ?string $regent_department=null,
        /** @var string|null */
        public ?string $regent_faculty_profile_url=null,
        /** @var string|null */
        public ?string $regent_image_url=null,
        /** @var bool|null */
        public ?bool $include_on_website=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['spouse_regent_id'])) $this->spouse_regent_id = $o['spouse_regent_id'];
        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['addr1'])) $this->addr1 = $o['addr1'];
        if (isset($o['addr2'])) $this->addr2 = $o['addr2'];
        if (isset($o['country'])) $this->country = $o['country'];
        if (isset($o['state'])) $this->state = $o['state'];
        if (isset($o['city'])) $this->city = $o['city'];
        if (isset($o['code'])) $this->code = $o['code'];
        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['email'])) $this->email = $o['email'];
        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_other'])) $this->citizenship_other = $o['citizenship_other'];
        if (isset($o['permanent_resident'])) $this->permanent_resident = $o['permanent_resident'];
        if (isset($o['denomination'])) $this->denomination = $o['denomination'];
        if (isset($o['occupation'])) $this->occupation = $o['occupation'];
        if (isset($o['ethnicity'])) $this->ethnicity = $o['ethnicity'];
        if (isset($o['gender'])) $this->gender = $o['gender'];
        if (isset($o['marital_status'])) $this->marital_status = $o['marital_status'];
        if (isset($o['deceased_date'])) $this->deceased_date = JsonConverters::from('DateTime', $o['deceased_date']);
        if (isset($o['tax_number'])) $this->tax_number = $o['tax_number'];
        if (isset($o['update_re_and_sugar'])) $this->update_re_and_sugar = $o['update_re_and_sugar'];
        if (isset($o['regent_title'])) $this->regent_title = $o['regent_title'];
        if (isset($o['regent_department'])) $this->regent_department = $o['regent_department'];
        if (isset($o['regent_faculty_profile_url'])) $this->regent_faculty_profile_url = $o['regent_faculty_profile_url'];
        if (isset($o['regent_image_url'])) $this->regent_image_url = $o['regent_image_url'];
        if (isset($o['include_on_website'])) $this->include_on_website = $o['include_on_website'];
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->spouse_regent_id)) $o['spouse_regent_id'] = $this->spouse_regent_id;
        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->addr1)) $o['addr1'] = $this->addr1;
        if (isset($this->addr2)) $o['addr2'] = $this->addr2;
        if (isset($this->country)) $o['country'] = $this->country;
        if (isset($this->state)) $o['state'] = $this->state;
        if (isset($this->city)) $o['city'] = $this->city;
        if (isset($this->code)) $o['code'] = $this->code;
        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->email)) $o['email'] = $this->email;
        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_other)) $o['citizenship_other'] = $this->citizenship_other;
        if (isset($this->permanent_resident)) $o['permanent_resident'] = $this->permanent_resident;
        if (isset($this->denomination)) $o['denomination'] = $this->denomination;
        if (isset($this->occupation)) $o['occupation'] = $this->occupation;
        if (isset($this->ethnicity)) $o['ethnicity'] = $this->ethnicity;
        if (isset($this->gender)) $o['gender'] = $this->gender;
        if (isset($this->marital_status)) $o['marital_status'] = $this->marital_status;
        if (isset($this->deceased_date)) $o['deceased_date'] = JsonConverters::to('DateTime', $this->deceased_date);
        if (isset($this->tax_number)) $o['tax_number'] = $this->tax_number;
        if (isset($this->update_re_and_sugar)) $o['update_re_and_sugar'] = $this->update_re_and_sugar;
        if (isset($this->regent_title)) $o['regent_title'] = $this->regent_title;
        if (isset($this->regent_department)) $o['regent_department'] = $this->regent_department;
        if (isset($this->regent_faculty_profile_url)) $o['regent_faculty_profile_url'] = $this->regent_faculty_profile_url;
        if (isset($this->regent_image_url)) $o['regent_image_url'] = $this->regent_image_url;
        if (isset($this->include_on_website)) $o['include_on_website'] = $this->include_on_website;
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP AddressAndBioUpdateRequest DTOs

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

HTTP + OTHER

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

POST /person/{uuid}/addressandbio/update HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String","spouse_regent_id":0,"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","addr1":"String","addr2":"String","country":"String","state":"String","city":"String","code":"String","phone_home":"String","phone_cell":"String","phone_bus":"String","email":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_other":"String","permanent_resident":"String","denomination":"String","occupation":"String","ethnicity":"String","gender":"String","marital_status":"String","deceased_date":"0001-01-01T00:00:00.0000000","tax_number":"String","update_re_and_sugar":false,"regent_title":"String","regent_department":"String","regent_faculty_profile_url":"String","regent_image_url":"String","include_on_website":false,"authorizing_uuid":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"update_success":false,"messages":["String"]}