Sanctions Search API: v2

<back to all web services

GetPepSearches

PEP
The following routes are available for this service:
POST/peps/listGet all PEP searches
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 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 PepSearchListItem() = 
        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

    [<AllowNullLiteral>]
    type ArrayOfPepSearchListItem() = 
        inherit ResizeArray<PepSearchListItem>()

    [<AllowNullLiteral>]
    type GetPepSearchesData() = 
        inherit BaseResponse()
        member val TotalSearchRecords:Int32 = new Int32() with get,set
        member val CurrentPageNum:Int32 = new Int32() with get,set
        member val MaxPageNum:Int32 = new Int32() with get,set
        member val SearchRecords:ArrayOfPepSearchListItem = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetPepSearchesResponse() = 
        [<DataMember>]
        member val Data:GetPepSearchesData = 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 GetPepSearchesRequest() = 
        ///<summary>
        ///If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
        ///</summary>
        [<ApiMember(Description="If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view")>]
        member val SubUserName:String = null with get,set

        member val ListUnresolvedSearches:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ListUpdatedSearches:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ListArchivedSearches:Boolean = new Boolean() with get,set
        member val Page:Int32 = new Int32() with get,set
        member val SortOrder:String = null with get,set
        member val NameSearch:String = null with get,set
        member val NameSearchExact:Boolean = new Boolean() with get,set
        member val FilterReference:String = null with get,set
        member val FilterPepType:String = null with get,set
        member val FilterType:String = null with get,set
        member val FilterDateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val FilterDateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        ///<summary>
        ///If set, will only return searches created by the user
        ///</summary>
        [<ApiMember(Description="If set, will only return searches created by the user")>]
        member val FilterUserName:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetPepSearches() = 
        inherit BaseRequest()
        [<DataMember>]
        member val Request:GetPepSearchesRequest = null with get,set

F# GetPepSearches DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /peps/list HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetPepSearches xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <FilterDateFrom>0001-01-01T00:00:00</FilterDateFrom>
    <FilterDateTo>0001-01-01T00:00:00</FilterDateTo>
    <FilterPepType>String</FilterPepType>
    <FilterReference>String</FilterReference>
    <FilterType>String</FilterType>
    <FilterUserName>String</FilterUserName>
    <ListArchivedSearches>false</ListArchivedSearches>
    <ListUnresolvedSearches>false</ListUnresolvedSearches>
    <ListUpdatedSearches>false</ListUpdatedSearches>
    <NameSearch>String</NameSearch>
    <NameSearchExact>false</NameSearchExact>
    <Page>0</Page>
    <SortOrder>String</SortOrder>
    <SubUserName>String</SubUserName>
  </Request>
</GetPepSearches>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPepSearchesResponse 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>
    <CurrentPageNum>0</CurrentPageNum>
    <MaxPageNum>0</MaxPageNum>
    <SearchRecords>
      <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>
        <SearchType>String</SearchType>
      </SearchRecord>
    </SearchRecords>
    <TotalSearchRecords>0</TotalSearchRecords>
  </Data>
</GetPepSearchesResponse>