| Get a PEP search |
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SanctionsSearch.Api2.ServiceModel.Operations.PepSearches
Imports SanctionsSearch.Api2.ServiceModel.Operations.Base
Imports SanctionsSearch.Api2.ServiceModel.Types
Namespace Global
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.Operations.PepSearches
<DataContract>
Public Partial Class GetPepSearch
Inherits BaseRequest
<DataMember>
Public Overridable Property Request As GetPepSearchRequest
End Class
Public Partial Class GetPepSearchData
Inherits BaseResponse
Implements IBaseSearchResponse
Public Overridable Property LinkedTo As ArrayOfLinkedTo
Public Overridable Property SearchRecord As PepSearchRecord
End Class
Public Partial Class GetPepSearchRequest
'''<Summary>
'''If the search was created against a single Sub User account, specify their username here
'''</Summary>
<ApiMember(Description:="If the search was created against a single Sub User account, specify their username here")>
Public Overridable Property SubUserName As String
'''<Summary>
'''If set to true, the response will exclude resolved search results, it will only include unresolved results
'''</Summary>
<ApiMember(Description:="If set to true, the response will exclude resolved search results, it will only include unresolved results")>
Public Overridable Property OnlyShowUnresolvedResults As Boolean
Public Overridable Property Id As Long
End Class
<DataContract>
Public Partial Class GetPepSearchResponse
<DataMember>
Public Overridable Property Data As GetPepSearchData
End Class
End Namespace
Namespace SanctionsSearch.Api2.ServiceModel.Types
Public Partial Class ArrayOfLinkedTo
Inherits List(Of LinkedTo)
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 LinkedTo
Public Overridable Property ClientId As Nullable(Of Integer)
Public Overridable Property Id As Nullable(Of Long)
Public Overridable Property Type As String
Public Overridable Property Subtype As String
Public Overridable Property Status As String
Public Overridable Property Description As String
Public Overridable Property IsArchived As Nullable(Of Boolean)
Public Overridable Property Name As String
Public Overridable Property [Date] As Nullable(Of Date)
End Class
Public Partial Class PepSearchRecord
Public Overridable Property Id As Long
Public Overridable Property SearchType As String
Public Overridable Property DateSearched As Date
Public Overridable Property DateUpdated As Date
Public Overridable Property DateRenewal As Nullable(Of Date)
Public Overridable Property DateArchived As Nullable(Of Date)
Public Overridable Property IsArchived As Boolean
Public Overridable Property NumOfResults As Integer
Public Overridable Property ClientInResults As Boolean
Public Overridable Property ClientNotInResults As Boolean
Public Overridable Property AffectedByUpdate As Boolean
Public Overridable Property IsDayOneSearch As Boolean
Public Overridable Property SearchCriteria As SearchCriteria
Public Overridable Property SearchResults As PepSearchResults
End Class
Public Partial Class PepSearchResult
Public Sub New()
Addresses = New List(Of PepSearchResultAddress)
Aliases = New List(Of PepSearchResultAlias)
Articles = New List(Of PepSearchResultArticle)
Associations = New List(Of PepSearchResultIndividualAssociation)
BusinessAssociations = New List(Of PepSearchResultBusinessAssociation)
Notes = New List(Of PepSearchResultNote)
PoliticalPositions = New List(Of PepSearchResultPoliticalPosition)
End Sub
Public Overridable Property ResultSimilarity As Decimal
Public Overridable Property ResultResolved As Boolean
Public Overridable Property DateLastUpdated As Date
Public Overridable Property ResultIsClient As Boolean
Public Overridable Property Id As Long
Public Overridable Property Type As String
Public Overridable Property Title As String
Public Overridable Property Forename As String
Public Overridable Property Middlename As String
Public Overridable Property Surname As String
Public Overridable Property SoftDelete As Nullable(Of Boolean)
Public Overridable Property DateOfSoftDelete As Nullable(Of Date)
Public Overridable Property DateOfCapture As Nullable(Of Date)
Public Overridable Property DateOfBirth As Nullable(Of Date)
Public Overridable Property DateOfDeath As Nullable(Of Date)
Public Overridable Property YearOfBirth As Nullable(Of Integer)
Public Overridable Property YearOfDeath As Nullable(Of Integer)
Public Overridable Property Gender As String
Public Overridable Property HomeTelephone As String
Public Overridable Property BusinessTelephone As String
Public Overridable Property MobileTelephone As String
Public Overridable Property Fax As String
Public Overridable Property Email As String
Public Overridable Property Nationality As String
Public Overridable Property Source As String
Public Overridable Property Category As String
Public Overridable Property Picture As String
Public Overridable Property AlternateTitle As String
Public Overridable Property BusinessName As String
Public Overridable Property Description As String
Public Overridable Property Telephone As String
Public Overridable Property Website As String
Public Overridable Property PepTier As Nullable(Of Integer)
Public Overridable Property Addresses As List(Of PepSearchResultAddress)
Public Overridable Property Aliases As List(Of PepSearchResultAlias)
Public Overridable Property Articles As List(Of PepSearchResultArticle)
Public Overridable Property Associations As List(Of PepSearchResultIndividualAssociation)
Public Overridable Property BusinessAssociations As List(Of PepSearchResultBusinessAssociation)
Public Overridable Property Notes As List(Of PepSearchResultNote)
Public Overridable Property PoliticalPositions As List(Of PepSearchResultPoliticalPosition)
End Class
Public Partial Class PepSearchResultAddress
Public Overridable Property AddressLine1 As String
Public Overridable Property AddressLine2 As String
Public Overridable Property AddressLine3 As String
Public Overridable Property AddressLine4 As String
Public Overridable Property Town As String
Public Overridable Property County As String
Public Overridable Property PostCode As String
Public Overridable Property Country As String
Public Overridable Property ISOCountry As String
Public Overridable Property SoftDelete As Nullable(Of Boolean)
Public Overridable Property DateLastUpdated As Date
End Class
Public Partial Class PepSearchResultAlias
Public Overridable Property Forename As String
Public Overridable Property MiddleName As String
Public Overridable Property Surname As String
Public Overridable Property SoftDelete As Nullable(Of Boolean)
Public Overridable Property DateOfSoftDelete As Nullable(Of Date)
Public Overridable Property DateLastUpdated As Date
Public Overridable Property Title As String
Public Overridable Property AlternateTitle As String
Public Overridable Property BusinessName As String
End Class
Public Partial Class PepSearchResultArticle
Public Sub New()
Snippets = New List(Of PepSearchResultArticleSnippet)
End Sub
Public Overridable Property Url As String
Public Overridable Property OriginalUrl As String
Public Overridable Property Source As String
Public Overridable Property DateOfCapture As Nullable(Of Date)
Public Overridable Property DateLastUpdated As Date
Public Overridable Property Snippets As List(Of PepSearchResultArticleSnippet)
End Class
Public Partial Class PepSearchResultArticleSnippet
Public Overridable Property Title As String
Public Overridable Property Text As String
Public Overridable Property AdverseTerms As String
End Class
Public Partial Class PepSearchResultBusinessAssociation
Public Overridable Property LinkDescription As String
Public Overridable Property SoftDelete As Nullable(Of Boolean)
Public Overridable Property DateLastUpdated As Date
Public Overridable Property BusinessName As String
End Class
Public Partial Class PepSearchResultIndividualAssociation
Public Overridable Property LinkDescription As String
Public Overridable Property SoftDelete As Nullable(Of Boolean)
Public Overridable Property DateLastUpdated As Date
Public Overridable Property FullName As String
End Class
Public Partial Class PepSearchResultNote
Public Overridable Property Source As String
Public Overridable Property Notes As String
Public Overridable Property SoftDelete As Nullable(Of Boolean)
Public Overridable Property DateLastUpdated As Date
End Class
Public Partial Class PepSearchResultPoliticalPosition
Public Overridable Property Description As String
Public Overridable Property From As String
Public Overridable Property To As String
Public Overridable Property Country As String
Public Overridable Property SoftDelete As Nullable(Of Boolean)
Public Overridable Property DateLastUpdated As Date
End Class
Public Partial Class PepSearchResults
Public Sub New()
Results = New List(Of PepSearchResult)
End Sub
Public Overridable Property Results As List(Of PepSearchResult)
End Class
Public Partial Class SearchCriteria
Public Overridable Property Name As String
Public Overridable Property Address As String
Public Overridable Property Country As String
Public Overridable Property DateOfBirth As String
Public Overridable Property Nationality As String
Public Overridable Property Reference As String
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap12 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetPepSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<Id>0</Id>
<OnlyShowUnresolvedResults>false</OnlyShowUnresolvedResults>
<SubUserName>String</SubUserName>
</Request>
</GetPepSearch>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetPepSearchResponse 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>
<LinkedTo>
<LinkedTo>
<ClientId>0</ClientId>
<Date>0001-01-01T00:00:00</Date>
<Description>String</Description>
<Id>0</Id>
<IsArchived>false</IsArchived>
<Name>String</Name>
<Status>String</Status>
<Subtype>String</Subtype>
<Type>String</Type>
</LinkedTo>
</LinkedTo>
<SearchRecord>
<AffectedByUpdate>false</AffectedByUpdate>
<ClientInResults>false</ClientInResults>
<ClientNotInResults>false</ClientNotInResults>
<DateArchived>0001-01-01T00:00:00</DateArchived>
<DateRenewal>0001-01-01T00:00:00</DateRenewal>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Id>0</Id>
<IsArchived>false</IsArchived>
<IsDayOneSearch>false</IsDayOneSearch>
<NumOfResults>0</NumOfResults>
<SearchCriteria>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<Name>String</Name>
<Nationality>String</Nationality>
<Reference>String</Reference>
</SearchCriteria>
<SearchResults>
<Results>
<PepSearchResult>
<Addresses>
<PepSearchResultAddress>
<AddressLine1>String</AddressLine1>
<AddressLine2>String</AddressLine2>
<AddressLine3>String</AddressLine3>
<AddressLine4>String</AddressLine4>
<Country>String</Country>
<County>String</County>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<ISOCountry>String</ISOCountry>
<PostCode>String</PostCode>
<SoftDelete>false</SoftDelete>
<Town>String</Town>
</PepSearchResultAddress>
</Addresses>
<Aliases>
<PepSearchResultAlias>
<AlternateTitle>String</AlternateTitle>
<BusinessName>String</BusinessName>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<DateOfSoftDelete>0001-01-01T00:00:00</DateOfSoftDelete>
<Forename>String</Forename>
<MiddleName>String</MiddleName>
<SoftDelete>false</SoftDelete>
<Surname>String</Surname>
<Title>String</Title>
</PepSearchResultAlias>
</Aliases>
<AlternateTitle>String</AlternateTitle>
<Articles>
<PepSearchResultArticle>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<DateOfCapture>0001-01-01T00:00:00</DateOfCapture>
<OriginalUrl>String</OriginalUrl>
<Snippets>
<PepSearchResultArticleSnippet>
<AdverseTerms>String</AdverseTerms>
<Text>String</Text>
<Title>String</Title>
</PepSearchResultArticleSnippet>
</Snippets>
<Source>String</Source>
<Url>String</Url>
</PepSearchResultArticle>
</Articles>
<Associations>
<PepSearchResultIndividualAssociation>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<FullName>String</FullName>
<LinkDescription>String</LinkDescription>
<SoftDelete>false</SoftDelete>
</PepSearchResultIndividualAssociation>
</Associations>
<BusinessAssociations>
<PepSearchResultBusinessAssociation>
<BusinessName>String</BusinessName>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<LinkDescription>String</LinkDescription>
<SoftDelete>false</SoftDelete>
</PepSearchResultBusinessAssociation>
</BusinessAssociations>
<BusinessName>String</BusinessName>
<BusinessTelephone>String</BusinessTelephone>
<Category>String</Category>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<DateOfCapture>0001-01-01T00:00:00</DateOfCapture>
<DateOfDeath>0001-01-01T00:00:00</DateOfDeath>
<DateOfSoftDelete>0001-01-01T00:00:00</DateOfSoftDelete>
<Description>String</Description>
<Email>String</Email>
<Fax>String</Fax>
<Forename>String</Forename>
<Gender>String</Gender>
<HomeTelephone>String</HomeTelephone>
<Id>0</Id>
<Middlename>String</Middlename>
<MobileTelephone>String</MobileTelephone>
<Nationality>String</Nationality>
<Notes>
<PepSearchResultNote>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<Notes>String</Notes>
<SoftDelete>false</SoftDelete>
<Source>String</Source>
</PepSearchResultNote>
</Notes>
<PepTier>0</PepTier>
<Picture>String</Picture>
<PoliticalPositions>
<PepSearchResultPoliticalPosition>
<Country>String</Country>
<DateLastUpdated>0001-01-01T00:00:00</DateLastUpdated>
<Description>String</Description>
<From>String</From>
<SoftDelete>false</SoftDelete>
<To>String</To>
</PepSearchResultPoliticalPosition>
</PoliticalPositions>
<ResultIsClient>false</ResultIsClient>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<SoftDelete>false</SoftDelete>
<Source>String</Source>
<Surname>String</Surname>
<Telephone>String</Telephone>
<Title>String</Title>
<Type>String</Type>
<Website>String</Website>
<YearOfBirth>0</YearOfBirth>
<YearOfDeath>0</YearOfDeath>
</PepSearchResult>
</Results>
</SearchResults>
<SearchType>String</SearchType>
</SearchRecord>
</Data>
</GetPepSearchResponse>
</soap12:Body>
</soap12:Envelope>