| POST | /validid/list | Get all the ValidID 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 ValidIdSearchCriteria:
full_name: Optional[str] = None
date_of_birth: datetime.datetime = datetime.datetime(1, 1, 1)
gender: Optional[str] = None
address: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidIdListItem:
id: int = 0
type: int = 0
score: Optional[int] = None
status: Optional[str] = None
date_searched: datetime.datetime = datetime.datetime(1, 1, 1)
reference: Optional[str] = None
pep_error: bool = False
replaced: bool = False
replacement_search_id: Optional[int] = None
has_completed_request: bool = False
has_completed_search: bool = False
search_criteria: Optional[ValidIdSearchCriteria] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArrayOfValidIdListItem(List[ValidIdListItem]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetValidIdsData(BaseResponse):
total_search_records: int = 0
current_page_num: int = 0
max_page_num: int = 0
search_records: Optional[ArrayOfValidIdListItem] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetValidIdsResponse:
data: Optional[GetValidIdsData] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetValidIdsRequest:
# @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
"""
page: int = 0
sort_order: Optional[str] = None
name_search: Optional[str] = None
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
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetValidIds(BaseRequest):
request: Optional[GetValidIdsRequest] = None
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.
POST /validid/list HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","page":0,"sortOrder":"String","nameSearch":"String","filterReference":"String","filterType":"String","filterDateFrom":"\/Date(-62135596800000-0000)\/","filterDateTo":"\/Date(-62135596800000-0000)\/","filterUserName":"String"},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"totalSearchRecords":0,"currentPageNum":0,"maxPageNum":0,"searchRecords":[{"id":0,"type":0,"score":0,"status":"String","dateSearched":"\/Date(-62135596800000-0000)\/","reference":"String","pepError":false,"replaced":false,"replacementSearchId":0,"hasCompletedRequest":false,"hasCompletedSearch":false,"searchCriteria":{"fullName":"String","dateOfBirth":"\/Date(-62135596800000-0000)\/","gender":"String","address":"String"}}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}