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