| Required permission: | ReadPersonBaseValues |
| POST | /person/baseValues |
|---|
<?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 PersonExtendedResponse 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 int|null */
public ?int $spouse_regent_id=null,
/** @var string|null */
public ?string $uuid=null,
/** @var string|null */
public ?string $regent_login=null,
/** @var string|null */
public ?string $spouse_rwl=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 $override_transcript_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 bool|null */
public ?bool $is_donor=null,
/** @var bool|null */
public ?bool $is_vendor=null,
/** @var bool|null */
public ?bool $is_gp_customer=null,
/** @var string|null */
public ?string $crm_student_status=null,
/** @var string|null */
public ?string $crm_assigned=null,
/** @var string|null */
public ?string $last_registered_term=null,
/** @var bool|null */
public ?bool $is_regent_staff=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 $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 string|null */
public ?string $tax_number=null,
/** @var string|null */
public ?string $regent_current_program=null,
/** @var string|null */
public ?string $regent_degrees=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['spouse_regent_id'])) $this->spouse_regent_id = $o['spouse_regent_id'];
if (isset($o['uuid'])) $this->uuid = $o['uuid'];
if (isset($o['regent_login'])) $this->regent_login = $o['regent_login'];
if (isset($o['spouse_rwl'])) $this->spouse_rwl = $o['spouse_rwl'];
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['override_transcript_name'])) $this->override_transcript_name = $o['override_transcript_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['is_donor'])) $this->is_donor = $o['is_donor'];
if (isset($o['is_vendor'])) $this->is_vendor = $o['is_vendor'];
if (isset($o['is_gp_customer'])) $this->is_gp_customer = $o['is_gp_customer'];
if (isset($o['crm_student_status'])) $this->crm_student_status = $o['crm_student_status'];
if (isset($o['crm_assigned'])) $this->crm_assigned = $o['crm_assigned'];
if (isset($o['last_registered_term'])) $this->last_registered_term = $o['last_registered_term'];
if (isset($o['is_regent_staff'])) $this->is_regent_staff = $o['is_regent_staff'];
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['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['tax_number'])) $this->tax_number = $o['tax_number'];
if (isset($o['regent_current_program'])) $this->regent_current_program = $o['regent_current_program'];
if (isset($o['regent_degrees'])) $this->regent_degrees = $o['regent_degrees'];
}
/** @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->spouse_regent_id)) $o['spouse_regent_id'] = $this->spouse_regent_id;
if (isset($this->uuid)) $o['uuid'] = $this->uuid;
if (isset($this->regent_login)) $o['regent_login'] = $this->regent_login;
if (isset($this->spouse_rwl)) $o['spouse_rwl'] = $this->spouse_rwl;
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->override_transcript_name)) $o['override_transcript_name'] = $this->override_transcript_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->is_donor)) $o['is_donor'] = $this->is_donor;
if (isset($this->is_vendor)) $o['is_vendor'] = $this->is_vendor;
if (isset($this->is_gp_customer)) $o['is_gp_customer'] = $this->is_gp_customer;
if (isset($this->crm_student_status)) $o['crm_student_status'] = $this->crm_student_status;
if (isset($this->crm_assigned)) $o['crm_assigned'] = $this->crm_assigned;
if (isset($this->last_registered_term)) $o['last_registered_term'] = $this->last_registered_term;
if (isset($this->is_regent_staff)) $o['is_regent_staff'] = $this->is_regent_staff;
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->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->tax_number)) $o['tax_number'] = $this->tax_number;
if (isset($this->regent_current_program)) $o['regent_current_program'] = $this->regent_current_program;
if (isset($this->regent_degrees)) $o['regent_degrees'] = $this->regent_degrees;
return empty($o) ? new class(){} : $o;
}
}
class CountriesAndStatesResponse implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $country_code=null,
/** @var string|null */
public ?string $country_name=null,
/** @var array<string,string>|null */
public ?array $states=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['country_code'])) $this->country_code = $o['country_code'];
if (isset($o['country_name'])) $this->country_name = $o['country_name'];
if (isset($o['states'])) $this->states = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['states']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->country_code)) $o['country_code'] = $this->country_code;
if (isset($this->country_name)) $o['country_name'] = $this->country_name;
if (isset($this->states)) $o['states'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->states);
return empty($o) ? new class(){} : $o;
}
}
class PrefixResponse implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $prefix_code=null,
/** @var string|null */
public ?string $prefix_name=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['prefix_code'])) $this->prefix_code = $o['prefix_code'];
if (isset($o['prefix_name'])) $this->prefix_name = $o['prefix_name'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->prefix_code)) $o['prefix_code'] = $this->prefix_code;
if (isset($this->prefix_name)) $o['prefix_name'] = $this->prefix_name;
return empty($o) ? new class(){} : $o;
}
}
class Denomination implements JsonSerializable
{
public function __construct(
/** @var int */
public int $id=0,
/** @var string|null */
public ?string $code=null,
/** @var string|null */
public ?string $denomination_name=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['code'])) $this->code = $o['code'];
if (isset($o['denomination_name'])) $this->denomination_name = $o['denomination_name'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->code)) $o['code'] = $this->code;
if (isset($this->denomination_name)) $o['denomination_name'] = $this->denomination_name;
return empty($o) ? new class(){} : $o;
}
}
class Occupation implements JsonSerializable
{
public function __construct(
/** @var int */
public int $id=0,
/** @var string|null */
public ?string $code=null,
/** @var string|null */
public ?string $occupation_name=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['code'])) $this->code = $o['code'];
if (isset($o['occupation_name'])) $this->occupation_name = $o['occupation_name'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->code)) $o['code'] = $this->code;
if (isset($this->occupation_name)) $o['occupation_name'] = $this->occupation_name;
return empty($o) ? new class(){} : $o;
}
}
class Ethnicity implements JsonSerializable
{
public function __construct(
/** @var int */
public int $id=0,
/** @var string|null */
public ?string $code=null,
/** @var string|null */
public ?string $ethnicity_name=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['code'])) $this->code = $o['code'];
if (isset($o['ethnicity_name'])) $this->ethnicity_name = $o['ethnicity_name'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->code)) $o['code'] = $this->code;
if (isset($this->ethnicity_name)) $o['ethnicity_name'] = $this->ethnicity_name;
return empty($o) ? new class(){} : $o;
}
}
class PersonBaseValuesResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var PersonExtendedResponse|null */
public ?PersonExtendedResponse $person=null,
/** @var array<CountriesAndStatesResponse>|null */
public ?array $countriesAndStates=null,
/** @var array<PrefixResponse>|null */
public ?array $prefixes=null,
/** @var array<string,string>|null */
public ?array $maritalStatuses=null,
/** @var array<Denomination>|null */
public ?array $denominations=null,
/** @var array<Occupation>|null */
public ?array $occupations=null,
/** @var array<Ethnicity>|null */
public ?array $ethnicities=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
if (isset($o['person'])) $this->person = JsonConverters::from('PersonExtendedResponse', $o['person']);
if (isset($o['countriesAndStates'])) $this->countriesAndStates = JsonConverters::fromArray('CountriesAndStatesResponse', $o['countriesAndStates']);
if (isset($o['prefixes'])) $this->prefixes = JsonConverters::fromArray('PrefixResponse', $o['prefixes']);
if (isset($o['maritalStatuses'])) $this->maritalStatuses = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['maritalStatuses']);
if (isset($o['denominations'])) $this->denominations = JsonConverters::fromArray('Denomination', $o['denominations']);
if (isset($o['occupations'])) $this->occupations = JsonConverters::fromArray('Occupation', $o['occupations']);
if (isset($o['ethnicities'])) $this->ethnicities = JsonConverters::fromArray('Ethnicity', $o['ethnicities']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
if (isset($this->person)) $o['person'] = JsonConverters::to('PersonExtendedResponse', $this->person);
if (isset($this->countriesAndStates)) $o['countriesAndStates'] = JsonConverters::toArray('CountriesAndStatesResponse', $this->countriesAndStates);
if (isset($this->prefixes)) $o['prefixes'] = JsonConverters::toArray('PrefixResponse', $this->prefixes);
if (isset($this->maritalStatuses)) $o['maritalStatuses'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->maritalStatuses);
if (isset($this->denominations)) $o['denominations'] = JsonConverters::toArray('Denomination', $this->denominations);
if (isset($this->occupations)) $o['occupations'] = JsonConverters::toArray('Occupation', $this->occupations);
if (isset($this->ethnicities)) $o['ethnicities'] = JsonConverters::toArray('Ethnicity', $this->ethnicities);
return empty($o) ? new class(){} : $o;
}
}
class PersonBaseValuesRequest implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
PHP PersonBaseValuesRequest 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 /person/baseValues HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
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
}
},
person:
{
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,
spouse_regent_id: 0,
uuid: String,
regent_login: String,
spouse_rwl: String,
first_name: String,
middle_name: String,
last_name: String,
preferred_name: String,
birth_name: String,
override_transcript_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,
is_donor: False,
is_vendor: False,
is_gp_customer: False,
crm_student_status: String,
crm_assigned: String,
last_registered_term: String,
is_regent_staff: False,
regent_title: String,
regent_department: String,
regent_faculty_profile_url: String,
regent_image_url: String,
include_on_website: False,
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,
tax_number: String,
regent_current_program: String,
regent_degrees: String
},
countriesAndStates:
[
{
country_code: String,
country_name: String,
states:
{
String: String
}
}
],
prefixes:
[
{
prefix_code: String,
prefix_name: String
}
],
maritalStatuses:
{
String: String
},
denominations:
[
{
id: 0,
code: String,
denomination_name: String
}
],
occupations:
[
{
id: 0,
code: String,
occupation_name: String
}
],
ethnicities:
[
{
id: 0,
code: String,
ethnicity_name: String
}
]
}