| Get a PEP search |
namespace SanctionsSearch.Api2.ServiceModel.Operations.Base
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type ResponseError() =
[<DataMember(Order=1)>]
member val ErrorCode:String = null with get,set
[<DataMember(Order=2)>]
member val FieldName:String = null with get,set
[<DataMember(Order=3)>]
member val Message:String = null with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type ArrayOfResponseError() =
inherit ResizeArray<ResponseError>()
[<DataContract>]
[<AllowNullLiteral>]
type ResponseStatus() =
[<DataMember(Order=1)>]
member val ErrorCode:String = null with get,set
[<DataMember(Order=2)>]
member val Message:String = null with get,set
[<DataMember(Order=3)>]
member val StackTrace:String = null with get,set
[<DataMember(Order=4)>]
member val Errors:ArrayOfResponseError = null with get,set
[<DataMember(Order=5)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type BaseResponse() =
///<summary>
///The status of the response
///</summary>
[<ApiMember(Description="The status of the response")>]
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type LinkedTo() =
member val ClientId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
member val Type:String = null with get,set
member val Subtype:String = null with get,set
member val Status:String = null with get,set
member val Description:String = null with get,set
member val IsArchived:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val Name:String = null with get,set
member val Date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type ArrayOfLinkedTo() =
inherit ResizeArray<LinkedTo>()
[<AllowNullLiteral>]
type SearchCriteria() =
member val Name:String = null with get,set
member val Address:String = null with get,set
member val Country:String = null with get,set
member val DateOfBirth:String = null with get,set
member val Nationality:String = null with get,set
member val Reference:String = null with get,set
[<AllowNullLiteral>]
type PepSearchResultAddress() =
member val AddressLine1:String = null with get,set
member val AddressLine2:String = null with get,set
member val AddressLine3:String = null with get,set
member val AddressLine4:String = null with get,set
member val Town:String = null with get,set
member val County:String = null with get,set
member val PostCode:String = null with get,set
member val Country:String = null with get,set
member val ISOCountry:String = null with get,set
member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val DateLastUpdated:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type PepSearchResultAlias() =
member val Forename:String = null with get,set
member val MiddleName:String = null with get,set
member val Surname:String = null with get,set
member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val DateOfSoftDelete:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DateLastUpdated:DateTime = new DateTime() with get,set
member val Title:String = null with get,set
member val AlternateTitle:String = null with get,set
member val BusinessName:String = null with get,set
[<AllowNullLiteral>]
type PepSearchResultArticleSnippet() =
member val Title:String = null with get,set
member val Text:String = null with get,set
member val AdverseTerms:String = null with get,set
[<AllowNullLiteral>]
type PepSearchResultArticle() =
member val Url:String = null with get,set
member val OriginalUrl:String = null with get,set
member val Source:String = null with get,set
member val DateOfCapture:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DateLastUpdated:DateTime = new DateTime() with get,set
member val Snippets:ResizeArray<PepSearchResultArticleSnippet> = new ResizeArray<PepSearchResultArticleSnippet>() with get,set
[<AllowNullLiteral>]
type PepSearchResultIndividualAssociation() =
member val LinkDescription:String = null with get,set
member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val DateLastUpdated:DateTime = new DateTime() with get,set
member val FullName:String = null with get,set
[<AllowNullLiteral>]
type PepSearchResultBusinessAssociation() =
member val LinkDescription:String = null with get,set
member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val DateLastUpdated:DateTime = new DateTime() with get,set
member val BusinessName:String = null with get,set
[<AllowNullLiteral>]
type PepSearchResultNote() =
member val Source:String = null with get,set
member val Notes:String = null with get,set
member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val DateLastUpdated:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type PepSearchResultPoliticalPosition() =
member val Description:String = null with get,set
member val From:String = null with get,set
member val To:String = null with get,set
member val Country:String = null with get,set
member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val DateLastUpdated:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type PepSearchResult() =
member val ResultSimilarity:Decimal = new Decimal() with get,set
member val ResultResolved:Boolean = new Boolean() with get,set
member val DateLastUpdated:DateTime = new DateTime() with get,set
member val ResultIsClient:Boolean = new Boolean() with get,set
member val Id:Int64 = new Int64() with get,set
member val Type:String = null with get,set
member val Title:String = null with get,set
member val Forename:String = null with get,set
member val Middlename:String = null with get,set
member val Surname:String = null with get,set
member val SoftDelete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val DateOfSoftDelete:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DateOfCapture:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DateOfBirth:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DateOfDeath:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val YearOfBirth:Nullable<Int32> = new Nullable<Int32>() with get,set
member val YearOfDeath:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Gender:String = null with get,set
member val HomeTelephone:String = null with get,set
member val BusinessTelephone:String = null with get,set
member val MobileTelephone:String = null with get,set
member val Fax:String = null with get,set
member val Email:String = null with get,set
member val Nationality:String = null with get,set
member val Source:String = null with get,set
member val Category:String = null with get,set
member val Picture:String = null with get,set
member val AlternateTitle:String = null with get,set
member val BusinessName:String = null with get,set
member val Description:String = null with get,set
member val Telephone:String = null with get,set
member val Website:String = null with get,set
member val PepTier:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Addresses:ResizeArray<PepSearchResultAddress> = new ResizeArray<PepSearchResultAddress>() with get,set
member val Aliases:ResizeArray<PepSearchResultAlias> = new ResizeArray<PepSearchResultAlias>() with get,set
member val Articles:ResizeArray<PepSearchResultArticle> = new ResizeArray<PepSearchResultArticle>() with get,set
member val Associations:ResizeArray<PepSearchResultIndividualAssociation> = new ResizeArray<PepSearchResultIndividualAssociation>() with get,set
member val BusinessAssociations:ResizeArray<PepSearchResultBusinessAssociation> = new ResizeArray<PepSearchResultBusinessAssociation>() with get,set
member val Notes:ResizeArray<PepSearchResultNote> = new ResizeArray<PepSearchResultNote>() with get,set
member val PoliticalPositions:ResizeArray<PepSearchResultPoliticalPosition> = new ResizeArray<PepSearchResultPoliticalPosition>() with get,set
[<AllowNullLiteral>]
type PepSearchResults() =
member val Results:ResizeArray<PepSearchResult> = new ResizeArray<PepSearchResult>() with get,set
[<AllowNullLiteral>]
type PepSearchRecord() =
member val Id:Int64 = new Int64() with get,set
member val SearchType:String = null with get,set
member val DateSearched:DateTime = new DateTime() with get,set
member val DateUpdated:DateTime = new DateTime() with get,set
member val DateRenewal:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DateArchived:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val IsArchived:Boolean = new Boolean() with get,set
member val NumOfResults:Int32 = new Int32() with get,set
member val ClientInResults:Boolean = new Boolean() with get,set
member val ClientNotInResults:Boolean = new Boolean() with get,set
member val AffectedByUpdate:Boolean = new Boolean() with get,set
member val IsDayOneSearch:Boolean = new Boolean() with get,set
member val SearchCriteria:SearchCriteria = null with get,set
member val SearchResults:PepSearchResults = null with get,set
[<AllowNullLiteral>]
type GetPepSearchData() =
inherit BaseResponse()
member val LinkedTo:ArrayOfLinkedTo = null with get,set
member val SearchRecord:PepSearchRecord = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetPepSearchResponse() =
[<DataMember>]
member val Data:GetPepSearchData = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type 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")>]
member val ApiUserId:String = null with get,set
///<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")>]
member val ApiUserKey:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseRequest() =
///<summary>
///The authentication credentials
///</summary>
[<DataMember>]
[<ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")>]
member val Authentication:Authentication = null with get,set
[<AllowNullLiteral>]
type 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")>]
member val SubUserName:String = null with get,set
///<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")>]
member val OnlyShowUnresolvedResults:Boolean = new Boolean() with get,set
member val Id:Int64 = new Int64() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetPepSearch() =
inherit BaseRequest()
[<DataMember>]
member val Request:GetPepSearchRequest = null with get,set
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>