| Required role: | REGISUserRole |
| POST | /Registration/UnauthenticatedPerson |
|---|
<?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 UnauthenticatedPersonResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var int|null */
public ?int $regent_id=null,
/** @var string|null */
public ?string $reporting_term=null,
/** @var string|null */
public ?string $survey=null,
/** @var string|null */
public ?string $friend_referral=null,
/** @var string|null */
public ?string $other_referral=null,
/** @var bool|null */
public ?bool $is_returning=null,
/** @var bool|null */
public ?bool $is_applying=null,
/** @var bool|null */
public ?bool $is_landlord=null,
/** @var int */
public int $postsecondary_education_level=0,
/** @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 $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 $spouse_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 $added_by=null,
/** @var DateTime|null */
public ?DateTime $added_date=null,
/** @var string|null */
public ?string $last_changed_by=null,
/** @var DateTime|null */
public ?DateTime $last_changed_date=null,
/** @var string|null */
public ?string $addr_last_changed_by=null,
/** @var DateTime|null */
public ?DateTime $addr_last_changed_date=null,
/** @var DateTime */
public DateTime $timestamp=new DateTime(),
/** @var DateTime|null */
public ?DateTime $submitted_datetime=null,
/** @var int|null */
public ?int $submitted_by_unauthenticated_person_id=null,
/** @var DateTime|null */
public ?DateTime $authorized_datetime=null,
/** @var int|null */
public ?int $authorized_by_person_id=null,
/** @var DateTime|null */
public ?DateTime $archived_datetime=null,
/** @var int|null */
public ?int $archived_by_person_id=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['reporting_term'])) $this->reporting_term = $o['reporting_term'];
if (isset($o['survey'])) $this->survey = $o['survey'];
if (isset($o['friend_referral'])) $this->friend_referral = $o['friend_referral'];
if (isset($o['other_referral'])) $this->other_referral = $o['other_referral'];
if (isset($o['is_returning'])) $this->is_returning = $o['is_returning'];
if (isset($o['is_applying'])) $this->is_applying = $o['is_applying'];
if (isset($o['is_landlord'])) $this->is_landlord = $o['is_landlord'];
if (isset($o['postsecondary_education_level'])) $this->postsecondary_education_level = $o['postsecondary_education_level'];
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['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['spouse_name'])) $this->spouse_name = $o['spouse_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['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['last_changed_by'])) $this->last_changed_by = $o['last_changed_by'];
if (isset($o['last_changed_date'])) $this->last_changed_date = JsonConverters::from('DateTime', $o['last_changed_date']);
if (isset($o['addr_last_changed_by'])) $this->addr_last_changed_by = $o['addr_last_changed_by'];
if (isset($o['addr_last_changed_date'])) $this->addr_last_changed_date = JsonConverters::from('DateTime', $o['addr_last_changed_date']);
if (isset($o['timestamp'])) $this->timestamp = JsonConverters::from('DateTime', $o['timestamp']);
if (isset($o['submitted_datetime'])) $this->submitted_datetime = JsonConverters::from('DateTime', $o['submitted_datetime']);
if (isset($o['submitted_by_unauthenticated_person_id'])) $this->submitted_by_unauthenticated_person_id = $o['submitted_by_unauthenticated_person_id'];
if (isset($o['authorized_datetime'])) $this->authorized_datetime = JsonConverters::from('DateTime', $o['authorized_datetime']);
if (isset($o['authorized_by_person_id'])) $this->authorized_by_person_id = $o['authorized_by_person_id'];
if (isset($o['archived_datetime'])) $this->archived_datetime = JsonConverters::from('DateTime', $o['archived_datetime']);
if (isset($o['archived_by_person_id'])) $this->archived_by_person_id = $o['archived_by_person_id'];
}
/** @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->reporting_term)) $o['reporting_term'] = $this->reporting_term;
if (isset($this->survey)) $o['survey'] = $this->survey;
if (isset($this->friend_referral)) $o['friend_referral'] = $this->friend_referral;
if (isset($this->other_referral)) $o['other_referral'] = $this->other_referral;
if (isset($this->is_returning)) $o['is_returning'] = $this->is_returning;
if (isset($this->is_applying)) $o['is_applying'] = $this->is_applying;
if (isset($this->is_landlord)) $o['is_landlord'] = $this->is_landlord;
if (isset($this->postsecondary_education_level)) $o['postsecondary_education_level'] = $this->postsecondary_education_level;
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->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->spouse_name)) $o['spouse_name'] = $this->spouse_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->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->last_changed_by)) $o['last_changed_by'] = $this->last_changed_by;
if (isset($this->last_changed_date)) $o['last_changed_date'] = JsonConverters::to('DateTime', $this->last_changed_date);
if (isset($this->addr_last_changed_by)) $o['addr_last_changed_by'] = $this->addr_last_changed_by;
if (isset($this->addr_last_changed_date)) $o['addr_last_changed_date'] = JsonConverters::to('DateTime', $this->addr_last_changed_date);
if (isset($this->timestamp)) $o['timestamp'] = JsonConverters::to('DateTime', $this->timestamp);
if (isset($this->submitted_datetime)) $o['submitted_datetime'] = JsonConverters::to('DateTime', $this->submitted_datetime);
if (isset($this->submitted_by_unauthenticated_person_id)) $o['submitted_by_unauthenticated_person_id'] = $this->submitted_by_unauthenticated_person_id;
if (isset($this->authorized_datetime)) $o['authorized_datetime'] = JsonConverters::to('DateTime', $this->authorized_datetime);
if (isset($this->authorized_by_person_id)) $o['authorized_by_person_id'] = $this->authorized_by_person_id;
if (isset($this->archived_datetime)) $o['archived_datetime'] = JsonConverters::to('DateTime', $this->archived_datetime);
if (isset($this->archived_by_person_id)) $o['archived_by_person_id'] = $this->archived_by_person_id;
return empty($o) ? new class(){} : $o;
}
}
class UnauthenticatedPersonSearchRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $first_name=null,
/** @var string|null */
public ?string $last_name=null,
/** @var string|null */
public ?string $reporting_term=null,
/** @var string|null */
public ?string $email=null,
/** @var DateTime|null */
public ?DateTime $dob=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['first_name'])) $this->first_name = $o['first_name'];
if (isset($o['last_name'])) $this->last_name = $o['last_name'];
if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
if (isset($o['email'])) $this->email = $o['email'];
if (isset($o['dob'])) $this->dob = JsonConverters::from('DateTime', $o['dob']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->first_name)) $o['first_name'] = $this->first_name;
if (isset($this->last_name)) $o['last_name'] = $this->last_name;
if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
if (isset($this->email)) $o['email'] = $this->email;
if (isset($this->dob)) $o['dob'] = JsonConverters::to('DateTime', $this->dob);
return empty($o) ? new class(){} : $o;
}
}
PHP UnauthenticatedPersonSearchRequest 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 /Registration/UnauthenticatedPerson HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
first_name: String,
last_name: String,
reporting_term: String,
email: String,
dob: 0001-01-01
}
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
}
},
regent_id: 0,
reporting_term: String,
survey: String,
friend_referral: String,
other_referral: String,
is_returning: False,
is_applying: False,
is_landlord: False,
postsecondary_education_level: 0,
uuid: String,
regent_login: String,
first_name: String,
middle_name: String,
last_name: String,
preferred_name: String,
birth_name: String,
spouse_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-01,
citizenship: String,
citizenship_other: String,
permanent_resident: String,
denomination: String,
occupation: String,
ethnicity: String,
gender: String,
marital_status: String,
deceased_date: 0001-01-01,
added_by: String,
added_date: 0001-01-01,
last_changed_by: String,
last_changed_date: 0001-01-01,
addr_last_changed_by: String,
addr_last_changed_date: 0001-01-01,
timestamp: 0001-01-01,
submitted_datetime: 0001-01-01,
submitted_by_unauthenticated_person_id: 0,
authorized_datetime: 0001-01-01,
authorized_by_person_id: 0,
archived_datetime: 0001-01-01,
archived_by_person_id: 0
}