| POST | /pdfs/list | Get all PDFs |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SanctionsSearch.Api2.ServiceModel.Operations.Account
Imports SanctionsSearch.Api2.ServiceModel.Operations.Base
Imports SanctionsSearch.Api2.ServiceModel.Types
Namespace Global
Namespace SanctionsSearch.Api2.ServiceModel.Operations.Account
<DataContract>
Public Partial Class GetPdfs
Inherits BaseRequest
'''<Summary>
'''The request data
'''</Summary>
<DataMember>
<ApiMember(Description:="The request data", ParameterType:="body")>
Public Overridable Property Request As GetPdfsRequest
End Class
Public Partial Class GetPdfsData
Inherits BaseResponse
'''<Summary>
'''List of Documents, but not including the file data
'''</Summary>
<ApiMember(Description:="List of Documents, but not including the file data")>
Public Overridable Property Documents As ArrayOfPdfDocument
End Class
Public Partial Class GetPdfsRequest
'''<Summary>
'''If the saved documents are kept within a single Sub User account, specify their username here
'''</Summary>
<ApiMember(Description:="If the saved documents are kept within a single Sub User account, specify their username here")>
Public Overridable Property SubUserName As String
End Class
<DataContract>
Public Partial Class GetPdfsResponse
'''<Summary>
'''The response data
'''</Summary>
<DataMember>
<ApiMember(Description:="The response data")>
Public Overridable Property Data As GetPdfsData
End Class
End Namespace
Namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
Public Partial Class ArrayOfResponseError
Inherits List(Of ResponseError)
End Class
<DataContract>
Public Partial Class BaseRequest
Implements IBaseRequest
'''<Summary>
'''The authentication credentials
'''</Summary>
<DataMember>
<ApiMember(Description:="The authentication credentials", IsRequired:=true, ParameterType:="header, body")>
Public Overridable Property Authentication As Authentication
End Class
Public Partial Class BaseResponse
Implements IBaseDataResponse
Implements IHasResponseStatus
'''<Summary>
'''The status of the response
'''</Summary>
<ApiMember(Description:="The status of the response")>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
<DataContract>
Public Partial Class ResponseError
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property ErrorCode As String
<DataMember(Order:=2)>
Public Overridable Property FieldName As String
<DataMember(Order:=3)>
Public Overridable Property Message As String
<DataMember(Order:=4)>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
<DataContract>
Public Partial Class ResponseStatus
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property ErrorCode As String
<DataMember(Order:=2)>
Public Overridable Property Message As String
<DataMember(Order:=3)>
Public Overridable Property StackTrace As String
<DataMember(Order:=4)>
Public Overridable Property Errors As ArrayOfResponseError
<DataMember(Order:=5)>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
End Namespace
Namespace SanctionsSearch.Api2.ServiceModel.Types
Public Partial Class ArrayOfPdfDocument
Inherits List(Of PdfDocument)
End Class
<DataContract>
Public Partial Class Authentication
'''<Summary>
'''The API User ID provided by us when you signed up to use our API
'''</Summary>
<DataMember>
<ApiMember(Description:="The API User ID provided by us when you signed up to use our API", IsRequired:=true, ParameterType:="header, body")>
Public Overridable Property ApiUserId As String
'''<Summary>
'''The API User Key provided by us when you signed up to use our API
'''</Summary>
<DataMember>
<ApiMember(Description:="The API User Key provided by us when you signed up to use our API", IsRequired:=true, ParameterType:="header, body")>
Public Overridable Property ApiUserKey As String
End Class
Public Partial Class PdfDocument
'''<Summary>
'''The ID of the saved document
'''</Summary>
<ApiMember(Description:="The ID of the saved document")>
Public Overridable Property Id As Long
'''<Summary>
'''Is the document ready to download
'''</Summary>
<ApiMember(Description:="Is the document ready to download")>
Public Overridable Property IsReady As Boolean
'''<Summary>
'''The name of the saved document
'''</Summary>
<ApiMember(Description:="The name of the saved document")>
Public Overridable Property Name As String
'''<Summary>
'''The file name (including extension) of the saved document
'''</Summary>
<ApiMember(Description:="The file name (including extension) of the saved document")>
Public Overridable Property FileName As String
'''<Summary>
'''The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.)
'''</Summary>
<ApiMember(Description:="The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.)")>
Public Overridable Property Type As String
'''<Summary>
'''If this document is a Saved Sanctions Search, the ID of the search it relates to
'''</Summary>
<ApiMember(Description:="If this document is a Saved Sanctions Search, the ID of the search it relates to")>
Public Overridable Property SanctionsSearchId As Nullable(Of Long)
'''<Summary>
'''If this document is a Saved PEP Search, the ID of the search it relates to
'''</Summary>
<ApiMember(Description:="If this document is a Saved PEP Search, the ID of the search it relates to")>
Public Overridable Property PepSearchId As Nullable(Of Long)
'''<Summary>
'''If this document is a Saved ValidID Search, the ID of the search it relates to
'''</Summary>
<ApiMember(Description:="If this document is a Saved ValidID Search, the ID of the search it relates to")>
Public Overridable Property ValidIdSearchId As Nullable(Of Integer)
'''<Summary>
'''If this document is a Saved CompanyLookup Search, the ID of the search it relates to
'''</Summary>
<ApiMember(Description:="If this document is a Saved CompanyLookup Search, the ID of the search it relates to")>
Public Overridable Property CompanyLookupSearchId As Nullable(Of Integer)
'''<Summary>
'''The date the saved document was created/requested
'''</Summary>
<ApiMember(Description:="The date the saved document was created/requested")>
Public Overridable Property DateCreated As Date
'''<Summary>
'''The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods
'''</Summary>
<ApiMember(Description:="The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods")>
Public Overridable Property DateExpires As Date
End Class
End Namespace
End Namespace
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 /pdfs/list HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetPdfs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<SubUserName>String</SubUserName>
</Request>
</GetPdfs>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetPdfsResponse 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>
<Documents>
<PdfDocument>
<CompanyLookupSearchId>0</CompanyLookupSearchId>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateExpires>0001-01-01T00:00:00</DateExpires>
<FileName>String</FileName>
<Id>0</Id>
<IsReady>false</IsReady>
<Name>String</Name>
<PepSearchId>0</PepSearchId>
<SanctionsSearchId>0</SanctionsSearchId>
<Type>String</Type>
<ValidIdSearchId>0</ValidIdSearchId>
</PdfDocument>
</Documents>
</Data>
</GetPdfsResponse>