| Get all sanctions searches |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Authentication:
# @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
api_user_id: Optional[str] = None
"""
The API User ID provided by us when you signed up to use our API
"""
# @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
api_user_key: Optional[str] = None
"""
The API User Key provided by us when you signed up to use our API
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest(IBaseRequest):
# @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
authentication: Optional[Authentication] = None
"""
The authentication credentials
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseError:
error_code: Optional[str] = None
field_name: Optional[str] = None
message: Optional[str] = None
meta: Optional[Dict[str, str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArrayOfResponseError(List[ResponseError]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseStatus:
error_code: Optional[str] = None
message: Optional[str] = None
stack_trace: Optional[str] = None
errors: Optional[ArrayOfResponseError] = None
meta: Optional[Dict[str, str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse(IBaseDataResponse, IHasResponseStatus):
# @ApiMember(Description="The status of the response")
response_status: Optional[ResponseStatus] = None
"""
The status of the response
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchCriteria:
name: Optional[str] = None
address: Optional[str] = None
country: Optional[str] = None
date_of_birth: Optional[str] = None
nationality: Optional[str] = None
reference: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchSource:
list_id: Optional[str] = None
list_name: Optional[str] = None
list_short_name: Optional[str] = None
is_affected_by_list_update: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchListItem:
id: int = 0
search_type: Optional[str] = None
date_searched: datetime.datetime = datetime.datetime(1, 1, 1)
date_updated: datetime.datetime = datetime.datetime(1, 1, 1)
date_archived: Optional[datetime.datetime] = None
is_archived: bool = False
num_of_results: int = 0
client_in_results: bool = False
client_not_in_results: bool = False
affected_by_update: bool = False
search_criteria: Optional[SearchCriteria] = None
search_sources: Optional[List[SearchSource]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArrayOfSearchListItem(List[SearchListItem]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSearchesData(BaseResponse):
total_search_records: int = 0
current_page_num: int = 0
max_page_num: int = 0
search_records: Optional[ArrayOfSearchListItem] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSearchesResponse:
data: Optional[GetSearchesData] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSearchesRequest:
# @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")
sub_user_name: Optional[str] = None
"""
If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
"""
list_unresolved_searches: Optional[bool] = None
list_updated_searches: Optional[bool] = None
list_archived_searches: bool = False
page: int = 0
sort_order: Optional[str] = None
name_search: Optional[str] = None
name_search_exact: bool = False
filter_reference: Optional[str] = None
filter_type: Optional[str] = None
filter_date_from: Optional[datetime.datetime] = None
filter_date_to: Optional[datetime.datetime] = None
# @ApiMember(Description="If set, will only return searches created by the user")
filter_user_name: Optional[str] = None
"""
If set, will only return searches created by the user
"""
include_search_sources_full: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSearches(BaseRequest):
request: Optional[GetSearchesRequest] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetSearches
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<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>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<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>
</soap:Body>
</soap:Envelope>