| POST | /sanctions/list | Get all sanctions searches |
|---|
<?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;
}
}
class SearchCriteria implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $name=null,
/** @var string|null */
public ?string $address=null,
/** @var string|null */
public ?string $country=null,
/** @var string|null */
public ?string $dateOfBirth=null,
/** @var string|null */
public ?string $nationality=null,
/** @var string|null */
public ?string $reference=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['address'])) $this->address = $o['address'];
if (isset($o['country'])) $this->country = $o['country'];
if (isset($o['dateOfBirth'])) $this->dateOfBirth = $o['dateOfBirth'];
if (isset($o['nationality'])) $this->nationality = $o['nationality'];
if (isset($o['reference'])) $this->reference = $o['reference'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->address)) $o['address'] = $this->address;
if (isset($this->country)) $o['country'] = $this->country;
if (isset($this->dateOfBirth)) $o['dateOfBirth'] = $this->dateOfBirth;
if (isset($this->nationality)) $o['nationality'] = $this->nationality;
if (isset($this->reference)) $o['reference'] = $this->reference;
return empty($o) ? new class(){} : $o;
}
}
class SearchSource implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $listId=null,
/** @var string|null */
public ?string $listName=null,
/** @var string|null */
public ?string $listShortName=null,
/** @var bool|null */
public ?bool $isAffectedByListUpdate=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['listId'])) $this->listId = $o['listId'];
if (isset($o['listName'])) $this->listName = $o['listName'];
if (isset($o['listShortName'])) $this->listShortName = $o['listShortName'];
if (isset($o['isAffectedByListUpdate'])) $this->isAffectedByListUpdate = $o['isAffectedByListUpdate'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->listId)) $o['listId'] = $this->listId;
if (isset($this->listName)) $o['listName'] = $this->listName;
if (isset($this->listShortName)) $o['listShortName'] = $this->listShortName;
if (isset($this->isAffectedByListUpdate)) $o['isAffectedByListUpdate'] = $this->isAffectedByListUpdate;
return empty($o) ? new class(){} : $o;
}
}
class SearchListItem implements JsonSerializable
{
public function __construct(
/** @var int */
public int $id=0,
/** @var string|null */
public ?string $searchType=null,
/** @var DateTime */
public DateTime $dateSearched=new DateTime(),
/** @var DateTime */
public DateTime $dateUpdated=new DateTime(),
/** @var DateTime|null */
public ?DateTime $dateArchived=null,
/** @var bool|null */
public ?bool $isArchived=null,
/** @var int */
public int $numOfResults=0,
/** @var bool|null */
public ?bool $clientInResults=null,
/** @var bool|null */
public ?bool $clientNotInResults=null,
/** @var bool|null */
public ?bool $affectedByUpdate=null,
/** @var SearchCriteria|null */
public ?SearchCriteria $searchCriteria=null,
/** @var array<SearchSource>|null */
public ?array $searchSources=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['searchType'])) $this->searchType = $o['searchType'];
if (isset($o['dateSearched'])) $this->dateSearched = JsonConverters::from('DateTime', $o['dateSearched']);
if (isset($o['dateUpdated'])) $this->dateUpdated = JsonConverters::from('DateTime', $o['dateUpdated']);
if (isset($o['dateArchived'])) $this->dateArchived = JsonConverters::from('DateTime', $o['dateArchived']);
if (isset($o['isArchived'])) $this->isArchived = $o['isArchived'];
if (isset($o['numOfResults'])) $this->numOfResults = $o['numOfResults'];
if (isset($o['clientInResults'])) $this->clientInResults = $o['clientInResults'];
if (isset($o['clientNotInResults'])) $this->clientNotInResults = $o['clientNotInResults'];
if (isset($o['affectedByUpdate'])) $this->affectedByUpdate = $o['affectedByUpdate'];
if (isset($o['searchCriteria'])) $this->searchCriteria = JsonConverters::from('SearchCriteria', $o['searchCriteria']);
if (isset($o['searchSources'])) $this->searchSources = JsonConverters::fromArray('SearchSource', $o['searchSources']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->searchType)) $o['searchType'] = $this->searchType;
if (isset($this->dateSearched)) $o['dateSearched'] = JsonConverters::to('DateTime', $this->dateSearched);
if (isset($this->dateUpdated)) $o['dateUpdated'] = JsonConverters::to('DateTime', $this->dateUpdated);
if (isset($this->dateArchived)) $o['dateArchived'] = JsonConverters::to('DateTime', $this->dateArchived);
if (isset($this->isArchived)) $o['isArchived'] = $this->isArchived;
if (isset($this->numOfResults)) $o['numOfResults'] = $this->numOfResults;
if (isset($this->clientInResults)) $o['clientInResults'] = $this->clientInResults;
if (isset($this->clientNotInResults)) $o['clientNotInResults'] = $this->clientNotInResults;
if (isset($this->affectedByUpdate)) $o['affectedByUpdate'] = $this->affectedByUpdate;
if (isset($this->searchCriteria)) $o['searchCriteria'] = JsonConverters::to('SearchCriteria', $this->searchCriteria);
if (isset($this->searchSources)) $o['searchSources'] = JsonConverters::toArray('SearchSource', $this->searchSources);
return empty($o) ? new class(){} : $o;
}
}
/**
* @template array of SearchListItem
*/
class ArrayOfSearchListItem extends \ArrayObject implements JsonSerializable
{
public function __construct(SearchListItem ...$items) {
parent::__construct($items, \ArrayObject::STD_PROP_LIST);
}
/** @throws \Exception */
public function append($value): void {
if ($value instanceof SearchListItem)
parent::append($value);
else
throw new \Exception("Can only append a SearchListItem to " . __CLASS__);
}
/** @throws Exception */
public function fromMap($o): void {
foreach ($o as $item) {
$el = new SearchListItem();
$el->fromMap($item);
$this->append($el);
}
}
/** @throws Exception */
public function jsonSerialize(): array {
return parent::getArrayCopy();
}
}
class GetSearchesData extends BaseResponse implements JsonSerializable
{
/**
* @param ResponseStatus|null $responseStatus
*/
public function __construct(
?ResponseStatus $responseStatus=null,
/** @var int */
public int $totalSearchRecords=0,
/** @var int */
public int $currentPageNum=0,
/** @var int */
public int $maxPageNum=0,
/** @var ArrayOfSearchListItem|null */
public ?ArrayOfSearchListItem $searchRecords=null
) {
parent::__construct($responseStatus);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['totalSearchRecords'])) $this->totalSearchRecords = $o['totalSearchRecords'];
if (isset($o['currentPageNum'])) $this->currentPageNum = $o['currentPageNum'];
if (isset($o['maxPageNum'])) $this->maxPageNum = $o['maxPageNum'];
if (isset($o['searchRecords'])) $this->searchRecords = JsonConverters::from('ArrayOfSearchListItem', $o['searchRecords']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->totalSearchRecords)) $o['totalSearchRecords'] = $this->totalSearchRecords;
if (isset($this->currentPageNum)) $o['currentPageNum'] = $this->currentPageNum;
if (isset($this->maxPageNum)) $o['maxPageNum'] = $this->maxPageNum;
if (isset($this->searchRecords)) $o['searchRecords'] = JsonConverters::to('ArrayOfSearchListItem', $this->searchRecords);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class GetSearchesResponse implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var GetSearchesData|null */
public ?GetSearchesData $data=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['data'])) $this->data = JsonConverters::from('GetSearchesData', $o['data']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->data)) $o['data'] = JsonConverters::to('GetSearchesData', $this->data);
return empty($o) ? new class(){} : $o;
}
}
class GetSearchesRequest implements JsonSerializable
{
public function __construct(
/** @description If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view */
// @ApiMember(Description="If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view")
/** @var string|null */
public ?string $subUserName=null,
/** @var bool|null */
public ?bool $listUnresolvedSearches=null,
/** @var bool|null */
public ?bool $listUpdatedSearches=null,
/** @var bool|null */
public ?bool $listArchivedSearches=null,
/** @var int */
public int $page=0,
/** @var string|null */
public ?string $sortOrder=null,
/** @var string|null */
public ?string $nameSearch=null,
/** @var bool|null */
public ?bool $nameSearchExact=null,
/** @var string|null */
public ?string $filterReference=null,
/** @var string|null */
public ?string $filterType=null,
/** @var DateTime|null */
public ?DateTime $filterDateFrom=null,
/** @var DateTime|null */
public ?DateTime $filterDateTo=null,
/** @description If set, will only return searches created by the user */
// @ApiMember(Description="If set, will only return searches created by the user")
/** @var string|null */
public ?string $filterUserName=null,
/** @var bool|null */
public ?bool $includeSearchSourcesFull=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['subUserName'])) $this->subUserName = $o['subUserName'];
if (isset($o['listUnresolvedSearches'])) $this->listUnresolvedSearches = $o['listUnresolvedSearches'];
if (isset($o['listUpdatedSearches'])) $this->listUpdatedSearches = $o['listUpdatedSearches'];
if (isset($o['listArchivedSearches'])) $this->listArchivedSearches = $o['listArchivedSearches'];
if (isset($o['page'])) $this->page = $o['page'];
if (isset($o['sortOrder'])) $this->sortOrder = $o['sortOrder'];
if (isset($o['nameSearch'])) $this->nameSearch = $o['nameSearch'];
if (isset($o['nameSearchExact'])) $this->nameSearchExact = $o['nameSearchExact'];
if (isset($o['filterReference'])) $this->filterReference = $o['filterReference'];
if (isset($o['filterType'])) $this->filterType = $o['filterType'];
if (isset($o['filterDateFrom'])) $this->filterDateFrom = JsonConverters::from('DateTime', $o['filterDateFrom']);
if (isset($o['filterDateTo'])) $this->filterDateTo = JsonConverters::from('DateTime', $o['filterDateTo']);
if (isset($o['filterUserName'])) $this->filterUserName = $o['filterUserName'];
if (isset($o['includeSearchSourcesFull'])) $this->includeSearchSourcesFull = $o['includeSearchSourcesFull'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->subUserName)) $o['subUserName'] = $this->subUserName;
if (isset($this->listUnresolvedSearches)) $o['listUnresolvedSearches'] = $this->listUnresolvedSearches;
if (isset($this->listUpdatedSearches)) $o['listUpdatedSearches'] = $this->listUpdatedSearches;
if (isset($this->listArchivedSearches)) $o['listArchivedSearches'] = $this->listArchivedSearches;
if (isset($this->page)) $o['page'] = $this->page;
if (isset($this->sortOrder)) $o['sortOrder'] = $this->sortOrder;
if (isset($this->nameSearch)) $o['nameSearch'] = $this->nameSearch;
if (isset($this->nameSearchExact)) $o['nameSearchExact'] = $this->nameSearchExact;
if (isset($this->filterReference)) $o['filterReference'] = $this->filterReference;
if (isset($this->filterType)) $o['filterType'] = $this->filterType;
if (isset($this->filterDateFrom)) $o['filterDateFrom'] = JsonConverters::to('DateTime', $this->filterDateFrom);
if (isset($this->filterDateTo)) $o['filterDateTo'] = JsonConverters::to('DateTime', $this->filterDateTo);
if (isset($this->filterUserName)) $o['filterUserName'] = $this->filterUserName;
if (isset($this->includeSearchSourcesFull)) $o['includeSearchSourcesFull'] = $this->includeSearchSourcesFull;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class GetSearches extends BaseRequest implements JsonSerializable
{
/**
* @param Authentication|null $authentication
*/
public function __construct(
?Authentication $authentication=null,
// @DataMember
/** @var GetSearchesRequest|null */
public ?GetSearchesRequest $request=null
) {
parent::__construct($authentication);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['request'])) $this->request = JsonConverters::from('GetSearchesRequest', $o['request']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->request)) $o['request'] = JsonConverters::to('GetSearchesRequest', $this->request);
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sanctions/list HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetSearches xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<FilterDateFrom>0001-01-01T00:00:00</FilterDateFrom>
<FilterDateTo>0001-01-01T00:00:00</FilterDateTo>
<FilterReference>String</FilterReference>
<FilterType>String</FilterType>
<FilterUserName>String</FilterUserName>
<IncludeSearchSourcesFull>false</IncludeSearchSourcesFull>
<ListArchivedSearches>false</ListArchivedSearches>
<ListUnresolvedSearches>false</ListUnresolvedSearches>
<ListUpdatedSearches>false</ListUpdatedSearches>
<NameSearch>String</NameSearch>
<NameSearchExact>false</NameSearchExact>
<Page>0</Page>
<SortOrder>String</SortOrder>
<SubUserName>String</SubUserName>
</Request>
</GetSearches>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetSearchesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Data>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
<CurrentPageNum>0</CurrentPageNum>
<MaxPageNum>0</MaxPageNum>
<SearchRecords>
<SearchRecord>
<AffectedByUpdate>false</AffectedByUpdate>
<ClientInResults>false</ClientInResults>
<ClientNotInResults>false</ClientNotInResults>
<DateArchived>0001-01-01T00:00:00</DateArchived>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Id>0</Id>
<IsArchived>false</IsArchived>
<NumOfResults>0</NumOfResults>
<SearchCriteria>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<Name>String</Name>
<Nationality>String</Nationality>
<Reference>String</Reference>
</SearchCriteria>
<SearchSources>
<SearchSource>
<IsAffectedByListUpdate>false</IsAffectedByListUpdate>
<ListId>String</ListId>
<ListName>String</ListName>
<ListShortName>String</ListShortName>
</SearchSource>
</SearchSources>
<SearchType>String</SearchType>
</SearchRecord>
</SearchRecords>
<TotalSearchRecords>0</TotalSearchRecords>
</Data>
</GetSearchesResponse>