| Required role: | REGISUserRole |
| POST | /admissions/{uuid}/bio/sync |
|---|
<?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 BioSyncResponse 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 BioResponse|null */
public ?BioResponse $sugar_bio=null,
/** @var BioResponse|null */
public ?BioResponse $regis_bio=null,
/** @var BioResponse|null */
public ?BioResponse $re_bio=null,
/** @var bool|null */
public ?bool $exists_in_sugar=null,
/** @var bool|null */
public ?bool $exists_in_re=null,
/** @var bool|null */
public ?bool $are_equal=null,
/** @var bool|null */
public ?bool $first_name_are_equal=null,
/** @var bool|null */
public ?bool $middle_name_are_equal=null,
/** @var bool|null */
public ?bool $last_name_are_equal=null,
/** @var bool|null */
public ?bool $preferred_name_are_equal=null,
/** @var bool|null */
public ?bool $birth_name_are_equal=null,
/** @var bool|null */
public ?bool $prefix_are_equal=null,
/** @var bool|null */
public ?bool $dob_are_equal=null,
/** @var bool|null */
public ?bool $deceased_are_equal=null,
/** @var bool|null */
public ?bool $citizenship_are_equal=null,
/** @var bool|null */
public ?bool $gender_are_equal=null,
/** @var bool|null */
public ?bool $marital_status_are_equal=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['sugar_bio'])) $this->sugar_bio = JsonConverters::from('BioResponse', $o['sugar_bio']);
if (isset($o['regis_bio'])) $this->regis_bio = JsonConverters::from('BioResponse', $o['regis_bio']);
if (isset($o['re_bio'])) $this->re_bio = JsonConverters::from('BioResponse', $o['re_bio']);
if (isset($o['exists_in_sugar'])) $this->exists_in_sugar = $o['exists_in_sugar'];
if (isset($o['exists_in_re'])) $this->exists_in_re = $o['exists_in_re'];
if (isset($o['are_equal'])) $this->are_equal = $o['are_equal'];
if (isset($o['first_name_are_equal'])) $this->first_name_are_equal = $o['first_name_are_equal'];
if (isset($o['middle_name_are_equal'])) $this->middle_name_are_equal = $o['middle_name_are_equal'];
if (isset($o['last_name_are_equal'])) $this->last_name_are_equal = $o['last_name_are_equal'];
if (isset($o['preferred_name_are_equal'])) $this->preferred_name_are_equal = $o['preferred_name_are_equal'];
if (isset($o['birth_name_are_equal'])) $this->birth_name_are_equal = $o['birth_name_are_equal'];
if (isset($o['prefix_are_equal'])) $this->prefix_are_equal = $o['prefix_are_equal'];
if (isset($o['dob_are_equal'])) $this->dob_are_equal = $o['dob_are_equal'];
if (isset($o['deceased_are_equal'])) $this->deceased_are_equal = $o['deceased_are_equal'];
if (isset($o['citizenship_are_equal'])) $this->citizenship_are_equal = $o['citizenship_are_equal'];
if (isset($o['gender_are_equal'])) $this->gender_are_equal = $o['gender_are_equal'];
if (isset($o['marital_status_are_equal'])) $this->marital_status_are_equal = $o['marital_status_are_equal'];
}
/** @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->sugar_bio)) $o['sugar_bio'] = JsonConverters::to('BioResponse', $this->sugar_bio);
if (isset($this->regis_bio)) $o['regis_bio'] = JsonConverters::to('BioResponse', $this->regis_bio);
if (isset($this->re_bio)) $o['re_bio'] = JsonConverters::to('BioResponse', $this->re_bio);
if (isset($this->exists_in_sugar)) $o['exists_in_sugar'] = $this->exists_in_sugar;
if (isset($this->exists_in_re)) $o['exists_in_re'] = $this->exists_in_re;
if (isset($this->are_equal)) $o['are_equal'] = $this->are_equal;
if (isset($this->first_name_are_equal)) $o['first_name_are_equal'] = $this->first_name_are_equal;
if (isset($this->middle_name_are_equal)) $o['middle_name_are_equal'] = $this->middle_name_are_equal;
if (isset($this->last_name_are_equal)) $o['last_name_are_equal'] = $this->last_name_are_equal;
if (isset($this->preferred_name_are_equal)) $o['preferred_name_are_equal'] = $this->preferred_name_are_equal;
if (isset($this->birth_name_are_equal)) $o['birth_name_are_equal'] = $this->birth_name_are_equal;
if (isset($this->prefix_are_equal)) $o['prefix_are_equal'] = $this->prefix_are_equal;
if (isset($this->dob_are_equal)) $o['dob_are_equal'] = $this->dob_are_equal;
if (isset($this->deceased_are_equal)) $o['deceased_are_equal'] = $this->deceased_are_equal;
if (isset($this->citizenship_are_equal)) $o['citizenship_are_equal'] = $this->citizenship_are_equal;
if (isset($this->gender_are_equal)) $o['gender_are_equal'] = $this->gender_are_equal;
if (isset($this->marital_status_are_equal)) $o['marital_status_are_equal'] = $this->marital_status_are_equal;
return empty($o) ? new class(){} : $o;
}
}
class BioSyncRequest 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;
}
}
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 /admissions/{uuid}/bio/sync 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,
sugar_bio:
{
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
},
regis_bio:
{
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
},
re_bio:
{
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
},
exists_in_sugar: False,
exists_in_re: False,
are_equal: False,
first_name_are_equal: False,
middle_name_are_equal: False,
last_name_are_equal: False,
preferred_name_are_equal: False,
birth_name_are_equal: False,
prefix_are_equal: False,
dob_are_equal: False,
deceased_are_equal: False,
citizenship_are_equal: False,
gender_are_equal: False,
marital_status_are_equal: False
}