| POST | /pdfs/get | Get a PDF |
|---|
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 PdfDocument:
# @ApiMember(Description="The ID of the saved document")
id: int = 0
"""
The ID of the saved document
"""
# @ApiMember(Description="Is the document ready to download")
is_ready: bool = False
"""
Is the document ready to download
"""
# @ApiMember(Description="The name of the saved document")
name: Optional[str] = None
"""
The name of the saved document
"""
# @ApiMember(Description="The file name (including extension) of the saved document")
file_name: Optional[str] = None
"""
The file name (including extension) of the saved document
"""
# @ApiMember(Description="The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.)")
type: Optional[str] = None
"""
The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.)
"""
# @ApiMember(Description="If this document is a Saved Sanctions Search, the ID of the search it relates to")
sanctions_search_id: Optional[int] = None
"""
If this document is a Saved Sanctions Search, the ID of the search it relates to
"""
# @ApiMember(Description="If this document is a Saved PEP Search, the ID of the search it relates to")
pep_search_id: Optional[int] = None
"""
If this document is a Saved PEP Search, the ID of the search it relates to
"""
# @ApiMember(Description="If this document is a Saved ValidID Search, the ID of the search it relates to")
valid_id_search_id: Optional[int] = None
"""
If this document is a Saved ValidID Search, the ID of the search it relates to
"""
# @ApiMember(Description="If this document is a Saved CompanyLookup Search, the ID of the search it relates to")
company_lookup_search_id: Optional[int] = None
"""
If this document is a Saved CompanyLookup Search, the ID of the search it relates to
"""
# @ApiMember(Description="The date the saved document was created/requested")
date_created: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The date the saved document was created/requested
"""
# @ApiMember(Description="The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods")
date_expires: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PdfDocumentWithData(PdfDocument):
# @ApiMember(Description="The file data in a byte array")
document_bytes: Optional[bytes] = None
"""
The file data in a byte array
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPdfData(BaseResponse):
# @ApiMember(Description="The single document that is being returned, including the file data")
document: Optional[PdfDocumentWithData] = None
"""
The single document that is being returned, including the file data
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPdfResponse:
# @ApiMember(Description="The response data")
data: Optional[GetPdfData] = None
"""
The response data
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPdfRequest:
# @ApiMember(Description="If the saved document is kept within a single Sub User account, specify their username here")
sub_user_name: Optional[str] = None
"""
If the saved document is kept within a single Sub User account, specify their username here
"""
# @ApiMember(Description="The ID of the document to retrieve")
id: int = 0
"""
The ID of the document to retrieve
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPdf(BaseRequest):
# @ApiMember(Description="The request data", ParameterType="body")
request: Optional[GetPdfRequest] = None
"""
The request data
"""
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 /pdfs/get HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","id":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"document":{"documentBytes":"AA==","id":0,"isReady":false,"name":"String","fileName":"String","type":"String","sanctionsSearchId":0,"pepSearchId":0,"validIdSearchId":0,"companyLookupSearchId":0,"dateCreated":"\/Date(-62135596800000-0000)\/","dateExpires":"\/Date(-62135596800000-0000)\/"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}