| POST | /peps/add | Add 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 FaceIsMatch:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val FaceIsMatchConfidence:Nullable<Decimal> = new Nullable<Decimal>() 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 SearchResultEuAddress() =
member val Street:String = null with get,set
member val City:String = null with get,set
member val Country:String = null with get,set
member val PostCode:String = null with get,set
member val Other:String = null with get,set
[<AllowNullLiteral>]
type SearchResultEuBirth() =
member val Date:String = null with get,set
member val Place:String = null with get,set
member val Country:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfacEuCitizenship() =
member val Country:String = null with get,set
[<AllowNullLiteral>]
type SearchResultEuName() =
member val FullName:String = null with get,set
member val Gender:String = null with get,set
[<AllowNullLiteral>]
type SearchResultEuPassport() =
member val Number:String = null with get,set
member val Country:String = null with get,set
[<AllowNullLiteral>]
type SearchResultEu() =
member val ResultStrength:Int32 = new Int32() with get,set
member val ResultSimilarity:Decimal = new Decimal() with get,set
member val ResultResolved:Boolean = new Boolean() with get,set
member val ResultType:String = null with get,set
member val DateUpdated:DateTime = new DateTime() with get,set
member val Addresses:ResizeArray<SearchResultEuAddress> = new ResizeArray<SearchResultEuAddress>() with get,set
member val Births:ResizeArray<SearchResultEuBirth> = new ResizeArray<SearchResultEuBirth>() with get,set
member val Citizenships:ResizeArray<SearchResultOfacEuCitizenship> = new ResizeArray<SearchResultOfacEuCitizenship>() with get,set
member val Names:ResizeArray<SearchResultEuName> = new ResizeArray<SearchResultEuName>() with get,set
member val Passports:ResizeArray<SearchResultEuPassport> = new ResizeArray<SearchResultEuPassport>() with get,set
[<AllowNullLiteral>]
type SearchResultHmTreasury() =
member val ResultStrength:Int32 = new Int32() with get,set
member val ResultSimilarity:Decimal = new Decimal() with get,set
member val ResultResolved:Boolean = new Boolean() with get,set
member val ResultType:String = null with get,set
member val DateListed:DateTime = new DateTime() with get,set
member val DateUpdated:DateTime = new DateTime() with get,set
member val Name1:String = null with get,set
member val Name2:String = null with get,set
member val Name3:String = null with get,set
member val Name4:String = null with get,set
member val Name5:String = null with get,set
member val Name6:String = null with get,set
member val DateOfBirth:String = null with get,set
member val CountryOfBirth:String = null with get,set
member val Nationality:String = null with get,set
member val Address1:String = null with get,set
member val Address2:String = null with get,set
member val Address3:String = null with get,set
member val Address4:String = null with get,set
member val Address5:String = null with get,set
member val Address6:String = null with get,set
member val PostCode:String = null with get,set
member val Country:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfacAddress() =
member val Address1:String = null with get,set
member val Address2:String = null with get,set
member val Address3:String = null with get,set
member val City:String = null with get,set
member val State:String = null with get,set
member val PostCode:String = null with get,set
member val Country:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfacAka() =
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val Type:String = null with get,set
member val Strength:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfacDateOfBirth() =
member val DateOfBirth:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfacNationality() =
member val Country:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfacPlaceOfBirth() =
member val PlaceOfBirth:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOfac() =
member val ResultStrength:Int32 = new Int32() with get,set
member val ResultSimilarity:Decimal = new Decimal() with get,set
member val ResultResolved:Boolean = new Boolean() with get,set
member val ResultType:String = null with get,set
member val DateUpdated:DateTime = new DateTime() with get,set
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val Addresses:ResizeArray<SearchResultOfacAddress> = new ResizeArray<SearchResultOfacAddress>() with get,set
member val Akas:ResizeArray<SearchResultOfacAka> = new ResizeArray<SearchResultOfacAka>() with get,set
member val DateOfBirths:ResizeArray<SearchResultOfacDateOfBirth> = new ResizeArray<SearchResultOfacDateOfBirth>() with get,set
member val Nationalities:ResizeArray<SearchResultOfacNationality> = new ResizeArray<SearchResultOfacNationality>() with get,set
member val PlaceOfBirths:ResizeArray<SearchResultOfacPlaceOfBirth> = new ResizeArray<SearchResultOfacPlaceOfBirth>() with get,set
[<AllowNullLiteral>]
type SearchResultDfat() =
member val ResultStrength:Int32 = new Int32() with get,set
member val ResultSimilarity:Decimal = new Decimal() with get,set
member val ResultResolved:Boolean = new Boolean() with get,set
member val ResultType:String = null with get,set
member val DateUpdated:DateTime = new DateTime() with get,set
member val FullName:String = null with get,set
member val Address:String = null with get,set
member val DateOfBirth:String = null with get,set
member val PlaceOfBirth:String = null with get,set
member val Nationality:String = null with get,set
[<AllowNullLiteral>]
type SearchResultOsfi() =
member val ResultStrength:Int32 = new Int32() with get,set
member val ResultSimilarity:Decimal = new Decimal() with get,set
member val ResultResolved:Boolean = new Boolean() with get,set
member val ResultType:String = null with get,set
member val DateUpdated:DateTime = new DateTime() with get,set
member val FullName:String = null with get,set
member val Address:String = null with get,set
member val DateOfBirth:String = null with get,set
member val PlaceOfBirth:String = null with get,set
member val Nationality:String = null with get,set
[<AllowNullLiteral>]
type SearchResultCanadianJustice() =
member val ResultStrength:Int32 = new Int32() with get,set
member val ResultSimilarity:Decimal = new Decimal() with get,set
member val ResultResolved:Boolean = new Boolean() with get,set
member val ResultType:String = null with get,set
member val DateUpdated:DateTime = new DateTime() with get,set
member val Name:String = null with get,set
member val DateOfBirth:String = null with get,set
member val Country:String = null with get,set
member val RefId:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type SearchResultCanadianSema() =
member val ResultStrength:Int32 = new Int32() with get,set
member val ResultSimilarity:Decimal = new Decimal() with get,set
member val ResultResolved:Boolean = new Boolean() with get,set
member val ResultType:String = null with get,set
member val DateUpdated:DateTime = new DateTime() with get,set
member val Name:String = null with get,set
member val DateOfBirth:String = null with get,set
member val Country:String = null with get,set
member val Schedule:String = null with get,set
member val Item:String = null with get,set
[<AllowNullLiteral>]
type SearchResultAddress() =
member val SearchResultAddressId:Int64 = new Int64() with get,set
member val Type:String = null with get,set
member val Address1:String = null with get,set
member val Address2:String = null with get,set
member val Address3:String = null with get,set
member val City: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
[<AllowNullLiteral>]
type SearchResultDateOfBirth() =
member val SearchResultDateOfBirthId:Int64 = new Int64() with get,set
member val DateOfBirth:String = null with get,set
member val Year:Nullable<Int16> = new Nullable<Int16>() with get,set
member val Month:Nullable<Byte> = new Nullable<Byte>() with get,set
member val Day:Nullable<Byte> = new Nullable<Byte>() with get,set
member val Type:String = null with get,set
[<AllowNullLiteral>]
type SearchResultName() =
member val SearchResultNameId:Int64 = new Int64() with get,set
member val Type:String = null with get,set
member val Title:String = null with get,set
member val FullName:String = null with get,set
member val ResultSimilarity:Decimal = new Decimal() with get,set
[<AllowNullLiteral>]
type SearchResultNationality() =
member val SearchResultNationalityId:Int64 = new Int64() with get,set
member val Nationality:String = null with get,set
[<AllowNullLiteral>]
type SearchResultPlaceOfBirth() =
member val SearchResultPlaceOfBirthId:Int64 = new Int64() with get,set
member val PlaceOfBirth:String = null with get,set
member val CountryOfBirth:String = null with get,set
[<AllowNullLiteral>]
type SearchResultRemark() =
member val SearchResultRemarkId:Int64 = new Int64() with get,set
member val Name:String = null with get,set
member val Description:String = null with get,set
[<AllowNullLiteral>]
type SearchResultEntry() =
member val SearchResultId:Int64 = new Int64() with get,set
member val ResultStrength:Int32 = new Int32() with get,set
member val ResultSimilarity:Decimal = new Decimal() with get,set
member val ResultResolved:Boolean = new Boolean() with get,set
member val ResultType:String = null with get,set
member val DateUpdated:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val SanctionsListId:String = null with get,set
member val SanctionsListName:String = null with get,set
member val Addresses:ResizeArray<SearchResultAddress> = new ResizeArray<SearchResultAddress>() with get,set
member val DatesOfBirth:ResizeArray<SearchResultDateOfBirth> = new ResizeArray<SearchResultDateOfBirth>() with get,set
member val Names:ResizeArray<SearchResultName> = new ResizeArray<SearchResultName>() with get,set
member val Nationalities:ResizeArray<SearchResultNationality> = new ResizeArray<SearchResultNationality>() with get,set
member val PlacesOfBirth:ResizeArray<SearchResultPlaceOfBirth> = new ResizeArray<SearchResultPlaceOfBirth>() with get,set
member val Remarks:ResizeArray<SearchResultRemark> = new ResizeArray<SearchResultRemark>() with get,set
[<AllowNullLiteral>]
type SearchResults() =
member val EuResults:ResizeArray<SearchResultEu> = new ResizeArray<SearchResultEu>() with get,set
member val HMTResults:ResizeArray<SearchResultHmTreasury> = new ResizeArray<SearchResultHmTreasury>() with get,set
member val HMTUkraineResults:ResizeArray<SearchResultHmTreasury> = new ResizeArray<SearchResultHmTreasury>() with get,set
member val OfacResults:ResizeArray<SearchResultOfac> = new ResizeArray<SearchResultOfac>() with get,set
member val OfacConsolidatedResults:ResizeArray<SearchResultOfac> = new ResizeArray<SearchResultOfac>() with get,set
member val DfatResults:ResizeArray<SearchResultDfat> = new ResizeArray<SearchResultDfat>() with get,set
member val OsfiResults:ResizeArray<SearchResultOsfi> = new ResizeArray<SearchResultOsfi>() with get,set
member val CanadianJusticeResults:ResizeArray<SearchResultCanadianJustice> = new ResizeArray<SearchResultCanadianJustice>() with get,set
member val CanadianSemaResults:ResizeArray<SearchResultCanadianSema> = new ResizeArray<SearchResultCanadianSema>() with get,set
member val SwissSecoResults:ResizeArray<SearchResultEntry> = new ResizeArray<SearchResultEntry>() with get,set
[<AllowNullLiteral>]
type SearchSource() =
member val ListId:String = null with get,set
member val ListName:String = null with get,set
member val ListShortName:String = null with get,set
member val IsAffectedByListUpdate:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<AllowNullLiteral>]
type ArrayOfSearchResultEntries() =
inherit ResizeArray<SearchResultEntry>()
[<AllowNullLiteral>]
type SearchRecord() =
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 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 SearchCriteria:SearchCriteria = null with get,set
member val SearchResults:SearchResults = null with get,set
member val SearchSources:ResizeArray<SearchSource> = new ResizeArray<SearchSource>() with get,set
member val ListSearchResults:ArrayOfSearchResultEntries = null with get,set
[<AllowNullLiteral>]
type AddPepSearchData() =
inherit BaseResponse()
member val LinkedTo:ArrayOfLinkedTo = null with get,set
member val SearchRecord:PepSearchRecord = null with get,set
member val IncludesSanctionsSearchRecord:Boolean = new Boolean() with get,set
member val SanctionsSearchRecord:SearchRecord = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type AddPepSearchResponse() =
[<DataMember>]
member val Data:AddPepSearchData = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type Authentication() =
///<summary>
///The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
///</summary>
[<DataMember>]
[<ApiMember(Description="The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)", 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. Can be provided in the request body, or as a header parameter (X-Api-Key)
///</summary>
[<DataMember>]
[<ApiMember(Description="The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)", IsRequired=true, ParameterType="header, body")>]
member val ApiUserKey:String = null with get,set
///<summary>
///The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).
///</summary>
[<DataMember>]
[<ApiMember(Description="The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).", ParameterType="header, body")>]
member val UserId: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 ArrayOfLists() =
inherit ResizeArray<String>()
[<AllowNullLiteral>]
type AddPepSearchRequest() =
///<summary>
///If the search should be saved against a single Sub User account, specify their username here
///</summary>
[<ApiMember(Description="If the search should be saved against a single Sub User account, specify their username here")>]
member val SubUserName:String = null with get,set
member val Type:String = null with get,set
member val Name:String = null with get,set
member val Country:String = null with get,set
member val Address: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
member val ExcludeResults:Boolean = new Boolean() with get,set
member val PerformSanctionsSearch:Boolean = new Boolean() with get,set
member val DayOneSearch:Boolean = new Boolean() with get,set
member val SelectedLists:ArrayOfLists = null with get,set
///<summary>
///If the search should be linked to other searches, specify the them here
///</summary>
[<ApiMember(Description="If the search should be linked to other searches, specify the them here")>]
member val LinkedTo:ArrayOfLinkedTo = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type AddPepSearch() =
inherit BaseRequest()
[<DataMember>]
member val Request:AddPepSearchRequest = null with get,set
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 /peps/add HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddPepSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
<UserId>String</UserId>
</Authentication>
<Request>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<DayOneSearch>false</DayOneSearch>
<ExcludeResults>false</ExcludeResults>
<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>
<Name>String</Name>
<Nationality>String</Nationality>
<PerformSanctionsSearch>false</PerformSanctionsSearch>
<Reference>String</Reference>
<SelectedLists>
<ListId>String</ListId>
</SelectedLists>
<SubUserName>String</SubUserName>
<Type>String</Type>
</Request>
</AddPepSearch>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AddPepSearchResponse 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>
<IncludesSanctionsSearchRecord>false</IncludesSanctionsSearchRecord>
<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>
<SanctionsSearchRecord>
<AffectedByUpdate>false</AffectedByUpdate>
<ClientInResults>false</ClientInResults>
<ClientNotInResults>false</ClientNotInResults>
<DateArchived>0001-01-01T00:00:00</DateArchived>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Id>0</Id>
<IsArchived>false</IsArchived>
<ListSearchResults>
<SearchResultEntry>
<Addresses>
<SearchResultAddress>
<Address1>String</Address1>
<Address2>String</Address2>
<Address3>String</Address3>
<City>String</City>
<Country>String</Country>
<County>String</County>
<PostCode>String</PostCode>
<SearchResultAddressId>0</SearchResultAddressId>
<Type>String</Type>
</SearchResultAddress>
</Addresses>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<DatesOfBirth>
<SearchResultDateOfBirth>
<DateOfBirth>String</DateOfBirth>
<Day>0</Day>
<Month>0</Month>
<SearchResultDateOfBirthId>0</SearchResultDateOfBirthId>
<Type>String</Type>
<Year>0</Year>
</SearchResultDateOfBirth>
</DatesOfBirth>
<Names>
<SearchResultName>
<FullName>String</FullName>
<ResultSimilarity>0</ResultSimilarity>
<SearchResultNameId>0</SearchResultNameId>
<Title>String</Title>
<Type>String</Type>
</SearchResultName>
</Names>
<Nationalities>
<SearchResultNationality>
<Nationality>String</Nationality>
<SearchResultNationalityId>0</SearchResultNationalityId>
</SearchResultNationality>
</Nationalities>
<PlacesOfBirth>
<SearchResultPlaceOfBirth>
<CountryOfBirth>String</CountryOfBirth>
<PlaceOfBirth>String</PlaceOfBirth>
<SearchResultPlaceOfBirthId>0</SearchResultPlaceOfBirthId>
</SearchResultPlaceOfBirth>
</PlacesOfBirth>
<Remarks>
<SearchResultRemark>
<Description>String</Description>
<Name>String</Name>
<SearchResultRemarkId>0</SearchResultRemarkId>
</SearchResultRemark>
</Remarks>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
<SanctionsListId>String</SanctionsListId>
<SanctionsListName>String</SanctionsListName>
<SearchResultId>0</SearchResultId>
</SearchResultEntry>
</ListSearchResults>
<NumOfResults>0</NumOfResults>
<SearchCriteria>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<Name>String</Name>
<Nationality>String</Nationality>
<Reference>String</Reference>
</SearchCriteria>
<SearchResults>
<CanadianJusticeResults>
<SearchResultCanadianJustice>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Name>String</Name>
<RefId>0</RefId>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
</SearchResultCanadianJustice>
</CanadianJusticeResults>
<CanadianSemaResults>
<SearchResultCanadianSema>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Item>String</Item>
<Name>String</Name>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
<Schedule>String</Schedule>
</SearchResultCanadianSema>
</CanadianSemaResults>
<DfatResults>
<SearchResultDfat>
<Address>String</Address>
<DateOfBirth>String</DateOfBirth>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<FullName>String</FullName>
<Nationality>String</Nationality>
<PlaceOfBirth>String</PlaceOfBirth>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
</SearchResultDfat>
</DfatResults>
<EuResults>
<SearchResultEu>
<Addresses>
<SearchResultEuAddress>
<City>String</City>
<Country>String</Country>
<Other>String</Other>
<PostCode>String</PostCode>
<Street>String</Street>
</SearchResultEuAddress>
</Addresses>
<Births>
<SearchResultEuBirth>
<Country>String</Country>
<Date>String</Date>
<Place>String</Place>
</SearchResultEuBirth>
</Births>
<Citizenships>
<SearchResultOfacEuCitizenship>
<Country>String</Country>
</SearchResultOfacEuCitizenship>
</Citizenships>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Names>
<SearchResultEuName>
<FullName>String</FullName>
<Gender>String</Gender>
</SearchResultEuName>
</Names>
<Passports>
<SearchResultEuPassport>
<Country>String</Country>
<Number>String</Number>
</SearchResultEuPassport>
</Passports>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
</SearchResultEu>
</EuResults>
<HMTResults>
<SearchResultHmTreasury>
<Address1>String</Address1>
<Address2>String</Address2>
<Address3>String</Address3>
<Address4>String</Address4>
<Address5>String</Address5>
<Address6>String</Address6>
<Country>String</Country>
<CountryOfBirth>String</CountryOfBirth>
<DateListed>0001-01-01T00:00:00</DateListed>
<DateOfBirth>String</DateOfBirth>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Name1>String</Name1>
<Name2>String</Name2>
<Name3>String</Name3>
<Name4>String</Name4>
<Name5>String</Name5>
<Name6>String</Name6>
<Nationality>String</Nationality>
<PostCode>String</PostCode>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
</SearchResultHmTreasury>
</HMTResults>
<HMTUkraineResults>
<SearchResultHmTreasury>
<Address1>String</Address1>
<Address2>String</Address2>
<Address3>String</Address3>
<Address4>String</Address4>
<Address5>String</Address5>
<Address6>String</Address6>
<Country>String</Country>
<CountryOfBirth>String</CountryOfBirth>
<DateListed>0001-01-01T00:00:00</DateListed>
<DateOfBirth>String</DateOfBirth>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Name1>String</Name1>
<Name2>String</Name2>
<Name3>String</Name3>
<Name4>String</Name4>
<Name5>String</Name5>
<Name6>String</Name6>
<Nationality>String</Nationality>
<PostCode>String</PostCode>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
</SearchResultHmTreasury>
</HMTUkraineResults>
<OfacConsolidatedResults>
<SearchResultOfac>
<Addresses>
<SearchResultOfacAddress>
<Address1>String</Address1>
<Address2>String</Address2>
<Address3>String</Address3>
<City>String</City>
<Country>String</Country>
<PostCode>String</PostCode>
<State>String</State>
</SearchResultOfacAddress>
</Addresses>
<Akas>
<SearchResultOfacAka>
<FirstName>String</FirstName>
<LastName>String</LastName>
<Strength>String</Strength>
<Type>String</Type>
</SearchResultOfacAka>
</Akas>
<DateOfBirths>
<SearchResultOfacDateOfBirth>
<DateOfBirth>String</DateOfBirth>
</SearchResultOfacDateOfBirth>
</DateOfBirths>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<FirstName>String</FirstName>
<LastName>String</LastName>
<Nationalities>
<SearchResultOfacNationality>
<Country>String</Country>
</SearchResultOfacNationality>
</Nationalities>
<PlaceOfBirths>
<SearchResultOfacPlaceOfBirth>
<PlaceOfBirth>String</PlaceOfBirth>
</SearchResultOfacPlaceOfBirth>
</PlaceOfBirths>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
</SearchResultOfac>
</OfacConsolidatedResults>
<OfacResults>
<SearchResultOfac>
<Addresses>
<SearchResultOfacAddress>
<Address1>String</Address1>
<Address2>String</Address2>
<Address3>String</Address3>
<City>String</City>
<Country>String</Country>
<PostCode>String</PostCode>
<State>String</State>
</SearchResultOfacAddress>
</Addresses>
<Akas>
<SearchResultOfacAka>
<FirstName>String</FirstName>
<LastName>String</LastName>
<Strength>String</Strength>
<Type>String</Type>
</SearchResultOfacAka>
</Akas>
<DateOfBirths>
<SearchResultOfacDateOfBirth>
<DateOfBirth>String</DateOfBirth>
</SearchResultOfacDateOfBirth>
</DateOfBirths>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<FirstName>String</FirstName>
<LastName>String</LastName>
<Nationalities>
<SearchResultOfacNationality>
<Country>String</Country>
</SearchResultOfacNationality>
</Nationalities>
<PlaceOfBirths>
<SearchResultOfacPlaceOfBirth>
<PlaceOfBirth>String</PlaceOfBirth>
</SearchResultOfacPlaceOfBirth>
</PlaceOfBirths>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
</SearchResultOfac>
</OfacResults>
<OsfiResults>
<SearchResultOsfi>
<Address>String</Address>
<DateOfBirth>String</DateOfBirth>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<FullName>String</FullName>
<Nationality>String</Nationality>
<PlaceOfBirth>String</PlaceOfBirth>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
</SearchResultOsfi>
</OsfiResults>
<SwissSecoResults>
<SearchResultEntry>
<Addresses>
<SearchResultAddress>
<Address1>String</Address1>
<Address2>String</Address2>
<Address3>String</Address3>
<City>String</City>
<Country>String</Country>
<County>String</County>
<PostCode>String</PostCode>
<SearchResultAddressId>0</SearchResultAddressId>
<Type>String</Type>
</SearchResultAddress>
</Addresses>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<DatesOfBirth>
<SearchResultDateOfBirth>
<DateOfBirth>String</DateOfBirth>
<Day>0</Day>
<Month>0</Month>
<SearchResultDateOfBirthId>0</SearchResultDateOfBirthId>
<Type>String</Type>
<Year>0</Year>
</SearchResultDateOfBirth>
</DatesOfBirth>
<Names>
<SearchResultName>
<FullName>String</FullName>
<ResultSimilarity>0</ResultSimilarity>
<SearchResultNameId>0</SearchResultNameId>
<Title>String</Title>
<Type>String</Type>
</SearchResultName>
</Names>
<Nationalities>
<SearchResultNationality>
<Nationality>String</Nationality>
<SearchResultNationalityId>0</SearchResultNationalityId>
</SearchResultNationality>
</Nationalities>
<PlacesOfBirth>
<SearchResultPlaceOfBirth>
<CountryOfBirth>String</CountryOfBirth>
<PlaceOfBirth>String</PlaceOfBirth>
<SearchResultPlaceOfBirthId>0</SearchResultPlaceOfBirthId>
</SearchResultPlaceOfBirth>
</PlacesOfBirth>
<Remarks>
<SearchResultRemark>
<Description>String</Description>
<Name>String</Name>
<SearchResultRemarkId>0</SearchResultRemarkId>
</SearchResultRemark>
</Remarks>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
<SanctionsListId>String</SanctionsListId>
<SanctionsListName>String</SanctionsListName>
<SearchResultId>0</SearchResultId>
</SearchResultEntry>
</SwissSecoResults>
</SearchResults>
<SearchSources>
<SearchSource>
<IsAffectedByListUpdate>false</IsAffectedByListUpdate>
<ListId>String</ListId>
<ListName>String</ListName>
<ListShortName>String</ListShortName>
</SearchSource>
</SearchSources>
<SearchType>String</SearchType>
</SanctionsSearchRecord>
<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>
<FaceIsMatch>false</FaceIsMatch>
<FaceIsMatchConfidence>0</FaceIsMatchConfidence>
<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>
</AddPepSearchResponse>