| POST | /peps/get | 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 .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 /peps/get HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","onlyShowUnresolvedResults":false,"id":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"searchRecord":{"id":0,"searchType":"String","dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","dateRenewal":"\/Date(-62135596800000-0000)\/","dateArchived":"\/Date(-62135596800000-0000)\/","isArchived":false,"numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"isDayOneSearch":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"searchResults":{"results":[{"resultSimilarity":0,"resultResolved":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/","resultIsClient":false,"id":0,"type":"String","title":"String","forename":"String","middlename":"String","surname":"String","softDelete":false,"dateOfSoftDelete":"\/Date(-62135596800000-0000)\/","dateOfCapture":"\/Date(-62135596800000-0000)\/","dateOfBirth":"\/Date(-62135596800000-0000)\/","dateOfDeath":"\/Date(-62135596800000-0000)\/","yearOfBirth":0,"yearOfDeath":0,"gender":"String","homeTelephone":"String","businessTelephone":"String","mobileTelephone":"String","fax":"String","email":"String","nationality":"String","source":"String","category":"String","picture":"String","alternateTitle":"String","businessName":"String","description":"String","telephone":"String","website":"String","pepTier":0,"addresses":[{"addressLine1":"String","addressLine2":"String","addressLine3":"String","addressLine4":"String","town":"String","county":"String","postCode":"String","country":"String","isoCountry":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/"}],"aliases":[{"forename":"String","middleName":"String","surname":"String","softDelete":false,"dateOfSoftDelete":"\/Date(-62135596800000-0000)\/","dateLastUpdated":"\/Date(-62135596800000-0000)\/","title":"String","alternateTitle":"String","businessName":"String"}],"articles":[{"url":"String","originalUrl":"String","source":"String","dateOfCapture":"\/Date(-62135596800000-0000)\/","dateLastUpdated":"\/Date(-62135596800000-0000)\/","snippets":[{"title":"String","text":"String","adverseTerms":"String"}]}],"associations":[{"linkDescription":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String"}],"businessAssociations":[{"linkDescription":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/","businessName":"String"}],"notes":[{"source":"String","notes":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/"}],"politicalPositions":[{"description":"String","from":"String","to":"String","country":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/"}]}]}},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}