| GET | /validid/template |
|---|
<?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};
// @DataContract
class Authentication implements JsonSerializable
{
public function __construct(
/** @description The API User ID provided by us when you signed up to use our API */
// @DataMember
// @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
/** @var string */
public string $apiUserId='',
/** @description The API User Key provided by us when you signed up to use our API */
// @DataMember
// @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
/** @var string */
public string $apiUserKey=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['apiUserId'])) $this->apiUserId = $o['apiUserId'];
if (isset($o['apiUserKey'])) $this->apiUserKey = $o['apiUserKey'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->apiUserId)) $o['apiUserId'] = $this->apiUserId;
if (isset($this->apiUserKey)) $o['apiUserKey'] = $this->apiUserKey;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseRequest implements IBaseRequest, JsonSerializable
{
public function __construct(
/** @description The authentication credentials */
// @DataMember
// @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
/** @var Authentication|null */
public ?Authentication $authentication=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['authentication'])) $this->authentication = JsonConverters::from('Authentication', $o['authentication']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->authentication)) $o['authentication'] = JsonConverters::to('Authentication', $this->authentication);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class ResponseError implements JsonSerializable
{
public function __construct(
// @DataMember(Order=1)
/** @var string|null */
public ?string $errorCode=null,
// @DataMember(Order=2)
/** @var string|null */
public ?string $fieldName=null,
// @DataMember(Order=3)
/** @var string|null */
public ?string $message=null,
// @DataMember(Order=4)
/** @var array<string,string>|null */
public ?array $meta=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['errorCode'])) $this->errorCode = $o['errorCode'];
if (isset($o['fieldName'])) $this->fieldName = $o['fieldName'];
if (isset($o['message'])) $this->message = $o['message'];
if (isset($o['meta'])) $this->meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['meta']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->errorCode)) $o['errorCode'] = $this->errorCode;
if (isset($this->fieldName)) $o['fieldName'] = $this->fieldName;
if (isset($this->message)) $o['message'] = $this->message;
if (isset($this->meta)) $o['meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->meta);
return empty($o) ? new class(){} : $o;
}
}
/**
* @template array of ResponseError
*/
class ArrayOfResponseError extends \ArrayObject implements JsonSerializable
{
public function __construct(ResponseError ...$items) {
parent::__construct($items, \ArrayObject::STD_PROP_LIST);
}
/** @throws \Exception */
public function append($value): void {
if ($value instanceof ResponseError)
parent::append($value);
else
throw new \Exception("Can only append a ResponseError to " . __CLASS__);
}
/** @throws Exception */
public function fromMap($o): void {
foreach ($o as $item) {
$el = new ResponseError();
$el->fromMap($item);
$this->append($el);
}
}
/** @throws Exception */
public function jsonSerialize(): array {
return parent::getArrayCopy();
}
}
// @DataContract
class ResponseStatus implements JsonSerializable
{
public function __construct(
// @DataMember(Order=1)
/** @var string|null */
public ?string $errorCode=null,
// @DataMember(Order=2)
/** @var string|null */
public ?string $message=null,
// @DataMember(Order=3)
/** @var string|null */
public ?string $stackTrace=null,
// @DataMember(Order=4)
/** @var ArrayOfResponseError|null */
public ?ArrayOfResponseError $errors=null,
// @DataMember(Order=5)
/** @var array<string,string>|null */
public ?array $meta=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['errorCode'])) $this->errorCode = $o['errorCode'];
if (isset($o['message'])) $this->message = $o['message'];
if (isset($o['stackTrace'])) $this->stackTrace = $o['stackTrace'];
if (isset($o['errors'])) $this->errors = JsonConverters::from('ArrayOfResponseError', $o['errors']);
if (isset($o['meta'])) $this->meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['meta']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->errorCode)) $o['errorCode'] = $this->errorCode;
if (isset($this->message)) $o['message'] = $this->message;
if (isset($this->stackTrace)) $o['stackTrace'] = $this->stackTrace;
if (isset($this->errors)) $o['errors'] = JsonConverters::to('ArrayOfResponseError', $this->errors);
if (isset($this->meta)) $o['meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->meta);
return empty($o) ? new class(){} : $o;
}
}
class BaseResponse implements IBaseDataResponse, IHasResponseStatus, JsonSerializable
{
public function __construct(
/** @description The status of the response */
// @ApiMember(Description="The status of the response")
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
/**
* @template array of String
*/
class ArrayOfLists extends \ArrayObject implements JsonSerializable
{
public function __construct(String ...$items) {
parent::__construct($items, \ArrayObject::STD_PROP_LIST);
}
/** @throws \Exception */
public function append($value): void {
if ($value instanceof String)
parent::append($value);
else
throw new \Exception("Can only append a String to " . __CLASS__);
}
/** @throws Exception */
public function fromMap($o): void {
foreach ($o as $item) {
$el = new String();
$el->fromMap($item);
$this->append($el);
}
}
/** @throws Exception */
public function jsonSerialize(): array {
return parent::getArrayCopy();
}
}
class LinkedTo implements JsonSerializable
{
public function __construct(
/** @var int|null */
public ?int $clientId=null,
/** @var int|null */
public ?int $id=null,
/** @var string|null */
public ?string $type=null,
/** @var string|null */
public ?string $subtype=null,
/** @var string|null */
public ?string $status=null,
/** @var string|null */
public ?string $description=null,
/** @var bool|null */
public ?bool $isArchived=null,
/** @var string|null */
public ?string $name=null,
/** @var DateTime|null */
public ?DateTime $date=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['clientId'])) $this->clientId = $o['clientId'];
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['type'])) $this->type = $o['type'];
if (isset($o['subtype'])) $this->subtype = $o['subtype'];
if (isset($o['status'])) $this->status = $o['status'];
if (isset($o['description'])) $this->description = $o['description'];
if (isset($o['isArchived'])) $this->isArchived = $o['isArchived'];
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['date'])) $this->date = JsonConverters::from('DateTime', $o['date']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->clientId)) $o['clientId'] = $this->clientId;
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->type)) $o['type'] = $this->type;
if (isset($this->subtype)) $o['subtype'] = $this->subtype;
if (isset($this->status)) $o['status'] = $this->status;
if (isset($this->description)) $o['description'] = $this->description;
if (isset($this->isArchived)) $o['isArchived'] = $this->isArchived;
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->date)) $o['date'] = JsonConverters::to('DateTime', $this->date);
return empty($o) ? new class(){} : $o;
}
}
/**
* @template array of LinkedTo
*/
class ArrayOfLinkedTo extends \ArrayObject implements JsonSerializable
{
public function __construct(LinkedTo ...$items) {
parent::__construct($items, \ArrayObject::STD_PROP_LIST);
}
/** @throws \Exception */
public function append($value): void {
if ($value instanceof LinkedTo)
parent::append($value);
else
throw new \Exception("Can only append a LinkedTo to " . __CLASS__);
}
/** @throws Exception */
public function fromMap($o): void {
foreach ($o as $item) {
$el = new LinkedTo();
$el->fromMap($item);
$this->append($el);
}
}
/** @throws Exception */
public function jsonSerialize(): array {
return parent::getArrayCopy();
}
}
class ValidIdBasicRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $name1=null,
/** @var string|null */
public ?string $name2=null,
/** @var string|null */
public ?string $name3=null,
/** @var DateTime|null */
public ?DateTime $dateOfBirth=null,
/** @var string|null */
public ?string $gender=null,
/** @var string|null */
public ?string $address1=null,
/** @var string|null */
public ?string $address2=null,
/** @var string|null */
public ?string $address3=null,
/** @var string|null */
public ?string $address4=null,
/** @var string|null */
public ?string $address5=null,
/** @var string|null */
public ?string $postCode=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['name1'])) $this->name1 = $o['name1'];
if (isset($o['name2'])) $this->name2 = $o['name2'];
if (isset($o['name3'])) $this->name3 = $o['name3'];
if (isset($o['dateOfBirth'])) $this->dateOfBirth = JsonConverters::from('DateTime', $o['dateOfBirth']);
if (isset($o['gender'])) $this->gender = $o['gender'];
if (isset($o['address1'])) $this->address1 = $o['address1'];
if (isset($o['address2'])) $this->address2 = $o['address2'];
if (isset($o['address3'])) $this->address3 = $o['address3'];
if (isset($o['address4'])) $this->address4 = $o['address4'];
if (isset($o['address5'])) $this->address5 = $o['address5'];
if (isset($o['postCode'])) $this->postCode = $o['postCode'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->name1)) $o['name1'] = $this->name1;
if (isset($this->name2)) $o['name2'] = $this->name2;
if (isset($this->name3)) $o['name3'] = $this->name3;
if (isset($this->dateOfBirth)) $o['dateOfBirth'] = JsonConverters::to('DateTime', $this->dateOfBirth);
if (isset($this->gender)) $o['gender'] = $this->gender;
if (isset($this->address1)) $o['address1'] = $this->address1;
if (isset($this->address2)) $o['address2'] = $this->address2;
if (isset($this->address3)) $o['address3'] = $this->address3;
if (isset($this->address4)) $o['address4'] = $this->address4;
if (isset($this->address5)) $o['address5'] = $this->address5;
if (isset($this->postCode)) $o['postCode'] = $this->postCode;
return empty($o) ? new class(){} : $o;
}
}
class ValidIdPassportRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $passport1=null,
/** @var string|null */
public ?string $passport2=null,
/** @var string|null */
public ?string $passport3=null,
/** @var string|null */
public ?string $passport4=null,
/** @var string|null */
public ?string $passport5=null,
/** @var string|null */
public ?string $passport6=null,
/** @var string|null */
public ?string $passport7=null,
/** @var string|null */
public ?string $passport8=null,
/** @var string|null */
public ?string $passportMrzLineOne1=null,
/** @var string|null */
public ?string $passportMrzLineOne2=null,
/** @var string|null */
public ?string $passportMrzLineOne3=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['passport1'])) $this->passport1 = $o['passport1'];
if (isset($o['passport2'])) $this->passport2 = $o['passport2'];
if (isset($o['passport3'])) $this->passport3 = $o['passport3'];
if (isset($o['passport4'])) $this->passport4 = $o['passport4'];
if (isset($o['passport5'])) $this->passport5 = $o['passport5'];
if (isset($o['passport6'])) $this->passport6 = $o['passport6'];
if (isset($o['passport7'])) $this->passport7 = $o['passport7'];
if (isset($o['passport8'])) $this->passport8 = $o['passport8'];
if (isset($o['passportMrzLineOne1'])) $this->passportMrzLineOne1 = $o['passportMrzLineOne1'];
if (isset($o['passportMrzLineOne2'])) $this->passportMrzLineOne2 = $o['passportMrzLineOne2'];
if (isset($o['passportMrzLineOne3'])) $this->passportMrzLineOne3 = $o['passportMrzLineOne3'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->passport1)) $o['passport1'] = $this->passport1;
if (isset($this->passport2)) $o['passport2'] = $this->passport2;
if (isset($this->passport3)) $o['passport3'] = $this->passport3;
if (isset($this->passport4)) $o['passport4'] = $this->passport4;
if (isset($this->passport5)) $o['passport5'] = $this->passport5;
if (isset($this->passport6)) $o['passport6'] = $this->passport6;
if (isset($this->passport7)) $o['passport7'] = $this->passport7;
if (isset($this->passport8)) $o['passport8'] = $this->passport8;
if (isset($this->passportMrzLineOne1)) $o['passportMrzLineOne1'] = $this->passportMrzLineOne1;
if (isset($this->passportMrzLineOne2)) $o['passportMrzLineOne2'] = $this->passportMrzLineOne2;
if (isset($this->passportMrzLineOne3)) $o['passportMrzLineOne3'] = $this->passportMrzLineOne3;
return empty($o) ? new class(){} : $o;
}
}
class ValidIdDrivingRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $driving1=null,
/** @var string|null */
public ?string $driving2=null,
/** @var string|null */
public ?string $driving3=null,
/** @var string|null */
public ?string $drivingPostcode=null,
/** @var string|null */
public ?string $drivingMailSort=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['driving1'])) $this->driving1 = $o['driving1'];
if (isset($o['driving2'])) $this->driving2 = $o['driving2'];
if (isset($o['driving3'])) $this->driving3 = $o['driving3'];
if (isset($o['drivingPostcode'])) $this->drivingPostcode = $o['drivingPostcode'];
if (isset($o['drivingMailSort'])) $this->drivingMailSort = $o['drivingMailSort'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->driving1)) $o['driving1'] = $this->driving1;
if (isset($this->driving2)) $o['driving2'] = $this->driving2;
if (isset($this->driving3)) $o['driving3'] = $this->driving3;
if (isset($this->drivingPostcode)) $o['drivingPostcode'] = $this->drivingPostcode;
if (isset($this->drivingMailSort)) $o['drivingMailSort'] = $this->drivingMailSort;
return empty($o) ? new class(){} : $o;
}
}
class ValidIdBirthRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $birthForeName=null,
/** @var string|null */
public ?string $birthMiddleName=null,
/** @var string|null */
public ?string $birthSurname=null,
/** @var string|null */
public ?string $birthMaidenName=null,
/** @var string|null */
public ?string $birthDistrict=null,
/** @var string|null */
public ?string $birthCertIssueNum=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['birthForeName'])) $this->birthForeName = $o['birthForeName'];
if (isset($o['birthMiddleName'])) $this->birthMiddleName = $o['birthMiddleName'];
if (isset($o['birthSurname'])) $this->birthSurname = $o['birthSurname'];
if (isset($o['birthMaidenName'])) $this->birthMaidenName = $o['birthMaidenName'];
if (isset($o['birthDistrict'])) $this->birthDistrict = $o['birthDistrict'];
if (isset($o['birthCertIssueNum'])) $this->birthCertIssueNum = $o['birthCertIssueNum'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->birthForeName)) $o['birthForeName'] = $this->birthForeName;
if (isset($this->birthMiddleName)) $o['birthMiddleName'] = $this->birthMiddleName;
if (isset($this->birthSurname)) $o['birthSurname'] = $this->birthSurname;
if (isset($this->birthMaidenName)) $o['birthMaidenName'] = $this->birthMaidenName;
if (isset($this->birthDistrict)) $o['birthDistrict'] = $this->birthDistrict;
if (isset($this->birthCertIssueNum)) $o['birthCertIssueNum'] = $this->birthCertIssueNum;
return empty($o) ? new class(){} : $o;
}
}
class ValidIdNIRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $niNumber=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['niNumber'])) $this->niNumber = $o['niNumber'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->niNumber)) $o['niNumber'] = $this->niNumber;
return empty($o) ? new class(){} : $o;
}
}
class ValidIdNHSRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $nhsNumber=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['nhsNumber'])) $this->nhsNumber = $o['nhsNumber'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->nhsNumber)) $o['nhsNumber'] = $this->nhsNumber;
return empty($o) ? new class(){} : $o;
}
}
class ValidIdElectricityRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $mpanNumber1=null,
/** @var string|null */
public ?string $mpanNumber2=null,
/** @var string|null */
public ?string $mpanNumber3=null,
/** @var string|null */
public ?string $mpanNumber4=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['mpanNumber1'])) $this->mpanNumber1 = $o['mpanNumber1'];
if (isset($o['mpanNumber2'])) $this->mpanNumber2 = $o['mpanNumber2'];
if (isset($o['mpanNumber3'])) $this->mpanNumber3 = $o['mpanNumber3'];
if (isset($o['mpanNumber4'])) $this->mpanNumber4 = $o['mpanNumber4'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->mpanNumber1)) $o['mpanNumber1'] = $this->mpanNumber1;
if (isset($this->mpanNumber2)) $o['mpanNumber2'] = $this->mpanNumber2;
if (isset($this->mpanNumber3)) $o['mpanNumber3'] = $this->mpanNumber3;
if (isset($this->mpanNumber4)) $o['mpanNumber4'] = $this->mpanNumber4;
return empty($o) ? new class(){} : $o;
}
}
class ValidIdBankRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $bankSortCode=null,
/** @var string|null */
public ?string $bankAccountNumber=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['bankSortCode'])) $this->bankSortCode = $o['bankSortCode'];
if (isset($o['bankAccountNumber'])) $this->bankAccountNumber = $o['bankAccountNumber'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->bankSortCode)) $o['bankSortCode'] = $this->bankSortCode;
if (isset($this->bankAccountNumber)) $o['bankAccountNumber'] = $this->bankAccountNumber;
return empty($o) ? new class(){} : $o;
}
}
class ValidIdCardNumberRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $cardNumber=null,
/** @var string|null */
public ?string $cardType=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['cardNumber'])) $this->cardNumber = $o['cardNumber'];
if (isset($o['cardType'])) $this->cardType = $o['cardType'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->cardNumber)) $o['cardNumber'] = $this->cardNumber;
if (isset($this->cardType)) $o['cardType'] = $this->cardType;
return empty($o) ? new class(){} : $o;
}
}
class ValidIdTravelVisaRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $travelVisa1=null,
/** @var string|null */
public ?string $travelVisa2=null,
/** @var string|null */
public ?string $travelVisa3=null,
/** @var string|null */
public ?string $travelVisa4=null,
/** @var string|null */
public ?string $travelVisa5=null,
/** @var string|null */
public ?string $travelVisa6=null,
/** @var string|null */
public ?string $travelVisa7=null,
/** @var string|null */
public ?string $travelVisa8=null,
/** @var string|null */
public ?string $travelVisa9=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['travelVisa1'])) $this->travelVisa1 = $o['travelVisa1'];
if (isset($o['travelVisa2'])) $this->travelVisa2 = $o['travelVisa2'];
if (isset($o['travelVisa3'])) $this->travelVisa3 = $o['travelVisa3'];
if (isset($o['travelVisa4'])) $this->travelVisa4 = $o['travelVisa4'];
if (isset($o['travelVisa5'])) $this->travelVisa5 = $o['travelVisa5'];
if (isset($o['travelVisa6'])) $this->travelVisa6 = $o['travelVisa6'];
if (isset($o['travelVisa7'])) $this->travelVisa7 = $o['travelVisa7'];
if (isset($o['travelVisa8'])) $this->travelVisa8 = $o['travelVisa8'];
if (isset($o['travelVisa9'])) $this->travelVisa9 = $o['travelVisa9'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->travelVisa1)) $o['travelVisa1'] = $this->travelVisa1;
if (isset($this->travelVisa2)) $o['travelVisa2'] = $this->travelVisa2;
if (isset($this->travelVisa3)) $o['travelVisa3'] = $this->travelVisa3;
if (isset($this->travelVisa4)) $o['travelVisa4'] = $this->travelVisa4;
if (isset($this->travelVisa5)) $o['travelVisa5'] = $this->travelVisa5;
if (isset($this->travelVisa6)) $o['travelVisa6'] = $this->travelVisa6;
if (isset($this->travelVisa7)) $o['travelVisa7'] = $this->travelVisa7;
if (isset($this->travelVisa8)) $o['travelVisa8'] = $this->travelVisa8;
if (isset($this->travelVisa9)) $o['travelVisa9'] = $this->travelVisa9;
return empty($o) ? new class(){} : $o;
}
}
class ValidIdIdCardRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $idCard1=null,
/** @var string|null */
public ?string $idCard2=null,
/** @var string|null */
public ?string $idCard3=null,
/** @var string|null */
public ?string $idCard4=null,
/** @var string|null */
public ?string $idCard5=null,
/** @var string|null */
public ?string $idCard6=null,
/** @var string|null */
public ?string $idCard7=null,
/** @var string|null */
public ?string $idCard8=null,
/** @var string|null */
public ?string $idCard9=null,
/** @var string|null */
public ?string $idCard10=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['idCard1'])) $this->idCard1 = $o['idCard1'];
if (isset($o['idCard2'])) $this->idCard2 = $o['idCard2'];
if (isset($o['idCard3'])) $this->idCard3 = $o['idCard3'];
if (isset($o['idCard4'])) $this->idCard4 = $o['idCard4'];
if (isset($o['idCard5'])) $this->idCard5 = $o['idCard5'];
if (isset($o['idCard6'])) $this->idCard6 = $o['idCard6'];
if (isset($o['idCard7'])) $this->idCard7 = $o['idCard7'];
if (isset($o['idCard8'])) $this->idCard8 = $o['idCard8'];
if (isset($o['idCard9'])) $this->idCard9 = $o['idCard9'];
if (isset($o['idCard10'])) $this->idCard10 = $o['idCard10'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->idCard1)) $o['idCard1'] = $this->idCard1;
if (isset($this->idCard2)) $o['idCard2'] = $this->idCard2;
if (isset($this->idCard3)) $o['idCard3'] = $this->idCard3;
if (isset($this->idCard4)) $o['idCard4'] = $this->idCard4;
if (isset($this->idCard5)) $o['idCard5'] = $this->idCard5;
if (isset($this->idCard6)) $o['idCard6'] = $this->idCard6;
if (isset($this->idCard7)) $o['idCard7'] = $this->idCard7;
if (isset($this->idCard8)) $o['idCard8'] = $this->idCard8;
if (isset($this->idCard9)) $o['idCard9'] = $this->idCard9;
if (isset($this->idCard10)) $o['idCard10'] = $this->idCard10;
return empty($o) ? new class(){} : $o;
}
}
class ValidIdPollNumberRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $pollNumber=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['pollNumber'])) $this->pollNumber = $o['pollNumber'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->pollNumber)) $o['pollNumber'] = $this->pollNumber;
return empty($o) ? new class(){} : $o;
}
}
class ValidIdMarriageRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $forename=null,
/** @var string|null */
public ?string $surname=null,
/** @var string|null */
public ?string $partnerForename=null,
/** @var string|null */
public ?string $partnerSurname=null,
/** @var string|null */
public ?string $date=null,
/** @var string|null */
public ?string $district=null,
/** @var string|null */
public ?string $certIssueNum=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['forename'])) $this->forename = $o['forename'];
if (isset($o['surname'])) $this->surname = $o['surname'];
if (isset($o['partnerForename'])) $this->partnerForename = $o['partnerForename'];
if (isset($o['partnerSurname'])) $this->partnerSurname = $o['partnerSurname'];
if (isset($o['date'])) $this->date = $o['date'];
if (isset($o['district'])) $this->district = $o['district'];
if (isset($o['certIssueNum'])) $this->certIssueNum = $o['certIssueNum'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->forename)) $o['forename'] = $this->forename;
if (isset($this->surname)) $o['surname'] = $this->surname;
if (isset($this->partnerForename)) $o['partnerForename'] = $this->partnerForename;
if (isset($this->partnerSurname)) $o['partnerSurname'] = $this->partnerSurname;
if (isset($this->date)) $o['date'] = $this->date;
if (isset($this->district)) $o['district'] = $this->district;
if (isset($this->certIssueNum)) $o['certIssueNum'] = $this->certIssueNum;
return empty($o) ? new class(){} : $o;
}
}
class AddValidIdRequest implements JsonSerializable
{
public function __construct(
/** @description If the search should be saved against a single Sub User account, specify their username here */
// @ApiMember(Description="If the search should be saved against a single Sub User account, specify their username here")
/** @var string|null */
public ?string $subUserName=null,
/** @var string|null */
public ?string $type=null,
/** @var bool|null */
public ?bool $addPepSearch=null,
/** @var string|null */
public ?string $pepSearchType=null,
/** @var bool|null */
public ?bool $addSanctionsSearch=null,
/** @var ArrayOfLists|null */
public ?ArrayOfLists $selectedLists=null,
/** @var string|null */
public ?string $reference=null,
/** @description If the search should be linked to other searches, specify the them here */
// @ApiMember(Description="If the search should be linked to other searches, specify the them here")
/** @var ArrayOfLinkedTo|null */
public ?ArrayOfLinkedTo $linkedTo=null,
/** @var ValidIdBasicRequest|null */
public ?ValidIdBasicRequest $basicRequest=null,
/** @var ValidIdPassportRequest|null */
public ?ValidIdPassportRequest $passportRequest=null,
/** @var ValidIdDrivingRequest|null */
public ?ValidIdDrivingRequest $drivingRequest=null,
/** @var ValidIdBirthRequest|null */
public ?ValidIdBirthRequest $birthRequest=null,
/** @var ValidIdNIRequest|null */
public ?ValidIdNIRequest $niRequest=null,
/** @var ValidIdNHSRequest|null */
public ?ValidIdNHSRequest $nhsRequest=null,
/** @var ValidIdElectricityRequest|null */
public ?ValidIdElectricityRequest $electricityRequest=null,
/** @var ValidIdBankRequest|null */
public ?ValidIdBankRequest $bankRequest=null,
/** @var ValidIdCardNumberRequest|null */
public ?ValidIdCardNumberRequest $cardNumberRequest=null,
/** @var ValidIdTravelVisaRequest|null */
public ?ValidIdTravelVisaRequest $travelVisaRequest=null,
/** @var ValidIdIdCardRequest|null */
public ?ValidIdIdCardRequest $idCardRequest=null,
/** @var ValidIdPollNumberRequest|null */
public ?ValidIdPollNumberRequest $pollNumberRequest=null,
/** @var ValidIdMarriageRequest|null */
public ?ValidIdMarriageRequest $marriageRequest=null,
/** @var bool|null */
public ?bool $passportEnabled=null,
/** @var bool|null */
public ?bool $passportChipEnabled=null,
/** @var bool|null */
public ?bool $drivingEnabled=null,
/** @var bool|null */
public ?bool $smartlinkEnabled=null,
/** @var bool|null */
public ?bool $niEnabled=null,
/** @var bool|null */
public ?bool $nhsEnabled=null,
/** @var bool|null */
public ?bool $electricityEnabled=null,
/** @var bool|null */
public ?bool $bankEnabled=null,
/** @var bool|null */
public ?bool $creditActiveEnabled=null,
/** @var bool|null */
public ?bool $idCardEnabled=null,
/** @var bool|null */
public ?bool $bankLiveEnabled=null,
/** @var bool|null */
public ?bool $companyDirectorEnabled=null,
/** @var bool|null */
public ?bool $searchActivityEnabled=null,
/** @var bool|null */
public ?bool $prsEnabled=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['subUserName'])) $this->subUserName = $o['subUserName'];
if (isset($o['type'])) $this->type = $o['type'];
if (isset($o['addPepSearch'])) $this->addPepSearch = $o['addPepSearch'];
if (isset($o['pepSearchType'])) $this->pepSearchType = $o['pepSearchType'];
if (isset($o['addSanctionsSearch'])) $this->addSanctionsSearch = $o['addSanctionsSearch'];
if (isset($o['selectedLists'])) $this->selectedLists = JsonConverters::from('ArrayOfLists', $o['selectedLists']);
if (isset($o['reference'])) $this->reference = $o['reference'];
if (isset($o['linkedTo'])) $this->linkedTo = JsonConverters::from('ArrayOfLinkedTo', $o['linkedTo']);
if (isset($o['basicRequest'])) $this->basicRequest = JsonConverters::from('ValidIdBasicRequest', $o['basicRequest']);
if (isset($o['passportRequest'])) $this->passportRequest = JsonConverters::from('ValidIdPassportRequest', $o['passportRequest']);
if (isset($o['drivingRequest'])) $this->drivingRequest = JsonConverters::from('ValidIdDrivingRequest', $o['drivingRequest']);
if (isset($o['birthRequest'])) $this->birthRequest = JsonConverters::from('ValidIdBirthRequest', $o['birthRequest']);
if (isset($o['niRequest'])) $this->niRequest = JsonConverters::from('ValidIdNIRequest', $o['niRequest']);
if (isset($o['nhsRequest'])) $this->nhsRequest = JsonConverters::from('ValidIdNHSRequest', $o['nhsRequest']);
if (isset($o['electricityRequest'])) $this->electricityRequest = JsonConverters::from('ValidIdElectricityRequest', $o['electricityRequest']);
if (isset($o['bankRequest'])) $this->bankRequest = JsonConverters::from('ValidIdBankRequest', $o['bankRequest']);
if (isset($o['cardNumberRequest'])) $this->cardNumberRequest = JsonConverters::from('ValidIdCardNumberRequest', $o['cardNumberRequest']);
if (isset($o['travelVisaRequest'])) $this->travelVisaRequest = JsonConverters::from('ValidIdTravelVisaRequest', $o['travelVisaRequest']);
if (isset($o['idCardRequest'])) $this->idCardRequest = JsonConverters::from('ValidIdIdCardRequest', $o['idCardRequest']);
if (isset($o['pollNumberRequest'])) $this->pollNumberRequest = JsonConverters::from('ValidIdPollNumberRequest', $o['pollNumberRequest']);
if (isset($o['marriageRequest'])) $this->marriageRequest = JsonConverters::from('ValidIdMarriageRequest', $o['marriageRequest']);
if (isset($o['passportEnabled'])) $this->passportEnabled = $o['passportEnabled'];
if (isset($o['passportChipEnabled'])) $this->passportChipEnabled = $o['passportChipEnabled'];
if (isset($o['drivingEnabled'])) $this->drivingEnabled = $o['drivingEnabled'];
if (isset($o['smartlinkEnabled'])) $this->smartlinkEnabled = $o['smartlinkEnabled'];
if (isset($o['niEnabled'])) $this->niEnabled = $o['niEnabled'];
if (isset($o['nhsEnabled'])) $this->nhsEnabled = $o['nhsEnabled'];
if (isset($o['electricityEnabled'])) $this->electricityEnabled = $o['electricityEnabled'];
if (isset($o['bankEnabled'])) $this->bankEnabled = $o['bankEnabled'];
if (isset($o['creditActiveEnabled'])) $this->creditActiveEnabled = $o['creditActiveEnabled'];
if (isset($o['idCardEnabled'])) $this->idCardEnabled = $o['idCardEnabled'];
if (isset($o['bankLiveEnabled'])) $this->bankLiveEnabled = $o['bankLiveEnabled'];
if (isset($o['companyDirectorEnabled'])) $this->companyDirectorEnabled = $o['companyDirectorEnabled'];
if (isset($o['searchActivityEnabled'])) $this->searchActivityEnabled = $o['searchActivityEnabled'];
if (isset($o['prsEnabled'])) $this->prsEnabled = $o['prsEnabled'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->subUserName)) $o['subUserName'] = $this->subUserName;
if (isset($this->type)) $o['type'] = $this->type;
if (isset($this->addPepSearch)) $o['addPepSearch'] = $this->addPepSearch;
if (isset($this->pepSearchType)) $o['pepSearchType'] = $this->pepSearchType;
if (isset($this->addSanctionsSearch)) $o['addSanctionsSearch'] = $this->addSanctionsSearch;
if (isset($this->selectedLists)) $o['selectedLists'] = JsonConverters::to('ArrayOfLists', $this->selectedLists);
if (isset($this->reference)) $o['reference'] = $this->reference;
if (isset($this->linkedTo)) $o['linkedTo'] = JsonConverters::to('ArrayOfLinkedTo', $this->linkedTo);
if (isset($this->basicRequest)) $o['basicRequest'] = JsonConverters::to('ValidIdBasicRequest', $this->basicRequest);
if (isset($this->passportRequest)) $o['passportRequest'] = JsonConverters::to('ValidIdPassportRequest', $this->passportRequest);
if (isset($this->drivingRequest)) $o['drivingRequest'] = JsonConverters::to('ValidIdDrivingRequest', $this->drivingRequest);
if (isset($this->birthRequest)) $o['birthRequest'] = JsonConverters::to('ValidIdBirthRequest', $this->birthRequest);
if (isset($this->niRequest)) $o['niRequest'] = JsonConverters::to('ValidIdNIRequest', $this->niRequest);
if (isset($this->nhsRequest)) $o['nhsRequest'] = JsonConverters::to('ValidIdNHSRequest', $this->nhsRequest);
if (isset($this->electricityRequest)) $o['electricityRequest'] = JsonConverters::to('ValidIdElectricityRequest', $this->electricityRequest);
if (isset($this->bankRequest)) $o['bankRequest'] = JsonConverters::to('ValidIdBankRequest', $this->bankRequest);
if (isset($this->cardNumberRequest)) $o['cardNumberRequest'] = JsonConverters::to('ValidIdCardNumberRequest', $this->cardNumberRequest);
if (isset($this->travelVisaRequest)) $o['travelVisaRequest'] = JsonConverters::to('ValidIdTravelVisaRequest', $this->travelVisaRequest);
if (isset($this->idCardRequest)) $o['idCardRequest'] = JsonConverters::to('ValidIdIdCardRequest', $this->idCardRequest);
if (isset($this->pollNumberRequest)) $o['pollNumberRequest'] = JsonConverters::to('ValidIdPollNumberRequest', $this->pollNumberRequest);
if (isset($this->marriageRequest)) $o['marriageRequest'] = JsonConverters::to('ValidIdMarriageRequest', $this->marriageRequest);
if (isset($this->passportEnabled)) $o['passportEnabled'] = $this->passportEnabled;
if (isset($this->passportChipEnabled)) $o['passportChipEnabled'] = $this->passportChipEnabled;
if (isset($this->drivingEnabled)) $o['drivingEnabled'] = $this->drivingEnabled;
if (isset($this->smartlinkEnabled)) $o['smartlinkEnabled'] = $this->smartlinkEnabled;
if (isset($this->niEnabled)) $o['niEnabled'] = $this->niEnabled;
if (isset($this->nhsEnabled)) $o['nhsEnabled'] = $this->nhsEnabled;
if (isset($this->electricityEnabled)) $o['electricityEnabled'] = $this->electricityEnabled;
if (isset($this->bankEnabled)) $o['bankEnabled'] = $this->bankEnabled;
if (isset($this->creditActiveEnabled)) $o['creditActiveEnabled'] = $this->creditActiveEnabled;
if (isset($this->idCardEnabled)) $o['idCardEnabled'] = $this->idCardEnabled;
if (isset($this->bankLiveEnabled)) $o['bankLiveEnabled'] = $this->bankLiveEnabled;
if (isset($this->companyDirectorEnabled)) $o['companyDirectorEnabled'] = $this->companyDirectorEnabled;
if (isset($this->searchActivityEnabled)) $o['searchActivityEnabled'] = $this->searchActivityEnabled;
if (isset($this->prsEnabled)) $o['prsEnabled'] = $this->prsEnabled;
return empty($o) ? new class(){} : $o;
}
}
class AddValidIdTemplateData extends BaseResponse implements JsonSerializable
{
/**
* @param ResponseStatus|null $responseStatus
*/
public function __construct(
?ResponseStatus $responseStatus=null,
/** @var AddValidIdRequest|null */
public ?AddValidIdRequest $request=null
) {
parent::__construct($responseStatus);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['request'])) $this->request = JsonConverters::from('AddValidIdRequest', $o['request']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->request)) $o['request'] = JsonConverters::to('AddValidIdRequest', $this->request);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class AddValidIdTemplateResponse implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var AddValidIdTemplateData|null */
public ?AddValidIdTemplateData $data=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['data'])) $this->data = JsonConverters::from('AddValidIdTemplateData', $o['data']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->data)) $o['data'] = JsonConverters::to('AddValidIdTemplateData', $this->data);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class AddValidIdTemplate extends BaseRequest implements JsonSerializable
{
/**
* @param Authentication|null $authentication
*/
public function __construct(
?Authentication $authentication=null,
// @DataMember
// @ApiMember(IsRequired=true)
/** @var int */
public int $clientId=0
) {
parent::__construct($authentication);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['clientId'])) $this->clientId = $o['clientId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->clientId)) $o['clientId'] = $this->clientId;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /validid/template HTTP/1.1 Host: api.sanctionssearch.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"request":{"subUserName":"String","type":"String","addPepSearch":false,"pepSearchType":"String","addSanctionsSearch":false,"selectedLists":["String"],"reference":"String","linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"basicRequest":{"name1":"String","name2":"String","name3":"String","dateOfBirth":"\/Date(-62135596800000-0000)\/","gender":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","postCode":"String"},"passportRequest":{"passport1":"String","passport2":"String","passport3":"String","passport4":"String","passport5":"String","passport6":"String","passport7":"String","passport8":"String","passportMrzLineOne1":"String","passportMrzLineOne2":"String","passportMrzLineOne3":"String"},"drivingRequest":{"driving1":"String","driving2":"String","driving3":"String","drivingPostcode":"String","drivingMailSort":"String"},"birthRequest":{"birthForeName":"String","birthMiddleName":"String","birthSurname":"String","birthMaidenName":"String","birthDistrict":"String","birthCertIssueNum":"String"},"niRequest":{"niNumber":"String"},"nhsRequest":{"nhsNumber":"String"},"electricityRequest":{"mpanNumber1":"String","mpanNumber2":"String","mpanNumber3":"String","mpanNumber4":"String"},"bankRequest":{"bankSortCode":"String","bankAccountNumber":"String"},"cardNumberRequest":{"cardNumber":"String","cardType":"String"},"travelVisaRequest":{"travelVisa1":"String","travelVisa2":"String","travelVisa3":"String","travelVisa4":"String","travelVisa5":"String","travelVisa6":"String","travelVisa7":"String","travelVisa8":"String","travelVisa9":"String"},"idCardRequest":{"idCard1":"String","idCard2":"String","idCard3":"String","idCard4":"String","idCard5":"String","idCard6":"String","idCard7":"String","idCard8":"String","idCard9":"String","idCard10":"String"},"pollNumberRequest":{"pollNumber":"String"},"marriageRequest":{"forename":"String","surname":"String","partnerForename":"String","partnerSurname":"String","date":"String","district":"String","certIssueNum":"String"},"passportEnabled":false,"passportChipEnabled":false,"drivingEnabled":false,"smartlinkEnabled":false,"niEnabled":false,"nhsEnabled":false,"electricityEnabled":false,"bankEnabled":false,"creditActiveEnabled":false,"idCardEnabled":false,"bankLiveEnabled":false,"companyDirectorEnabled":false,"searchActivityEnabled":false,"prsEnabled":false},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}