Sanctions Search API: v2

<back to all web services

GetSearches

Sanctions
The following routes are available for this service:
POST/sanctions/listGet all sanctions searches
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SanctionsSearch.Api2.ServiceModel.Operations.Searches
Imports SanctionsSearch.Api2.ServiceModel.Operations.Base
Imports SanctionsSearch.Api2.ServiceModel.Types

Namespace Global

    Namespace SanctionsSearch.Api2.ServiceModel.Operations.Base

        Public Partial Class ArrayOfResponseError
            Inherits List(Of ResponseError)
        End Class

        <DataContract>
        Public Partial Class BaseRequest
            Implements IBaseRequest
            '''<Summary>
            '''The authentication credentials
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The authentication credentials", IsRequired:=true, ParameterType:="header, body")>
            Public Overridable Property Authentication As Authentication
        End Class

        Public Partial Class BaseResponse
            Implements IBaseDataResponse
            Implements IHasResponseStatus
            '''<Summary>
            '''The status of the response
            '''</Summary>
            <ApiMember(Description:="The status of the response")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        <DataContract>
        Public Partial Class ResponseError
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property ErrorCode As String

            <DataMember(Order:=2)>
            Public Overridable Property FieldName As String

            <DataMember(Order:=3)>
            Public Overridable Property Message As String

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        <DataContract>
        Public Partial Class ResponseStatus
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property ErrorCode As String

            <DataMember(Order:=2)>
            Public Overridable Property Message As String

            <DataMember(Order:=3)>
            Public Overridable Property StackTrace As String

            <DataMember(Order:=4)>
            Public Overridable Property Errors As ArrayOfResponseError

            <DataMember(Order:=5)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class
    End Namespace

    Namespace SanctionsSearch.Api2.ServiceModel.Operations.Searches

        <DataContract>
        Public Partial Class GetSearches
            Inherits BaseRequest
            <DataMember>
            Public Overridable Property Request As GetSearchesRequest
        End Class

        Public Partial Class GetSearchesData
            Inherits BaseResponse
            Public Overridable Property TotalSearchRecords As Integer
            Public Overridable Property CurrentPageNum As Integer
            Public Overridable Property MaxPageNum As Integer
            Public Overridable Property SearchRecords As ArrayOfSearchListItem
        End Class

        Public Partial Class GetSearchesRequest
            '''<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")>
            Public Overridable Property SubUserName As String

            Public Overridable Property ListUnresolvedSearches As Nullable(Of Boolean)
            Public Overridable Property ListUpdatedSearches As Nullable(Of Boolean)
            Public Overridable Property ListArchivedSearches As Boolean
            Public Overridable Property Page As Integer
            Public Overridable Property SortOrder As String
            Public Overridable Property NameSearch As String
            Public Overridable Property NameSearchExact As Boolean
            Public Overridable Property FilterReference As String
            Public Overridable Property FilterType As String
            Public Overridable Property FilterDateFrom As Nullable(Of Date)
            Public Overridable Property FilterDateTo As Nullable(Of Date)
            '''<Summary>
            '''If set, will only return searches created by the user
            '''</Summary>
            <ApiMember(Description:="If set, will only return searches created by the user")>
            Public Overridable Property FilterUserName As String

            Public Overridable Property IncludeSearchSourcesFull As Boolean
        End Class

        <DataContract>
        Public Partial Class GetSearchesResponse
            <DataMember>
            Public Overridable Property Data As GetSearchesData
        End Class
    End Namespace

    Namespace SanctionsSearch.Api2.ServiceModel.Types

        Public Partial Class ArrayOfSearchListItem
            Inherits List(Of SearchListItem)
        End Class

        <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 Overridable Property ApiUserId As String

            '''<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 Overridable Property ApiUserKey As String
        End Class

        Public Partial Class SearchCriteria
            Public Overridable Property Name As String
            Public Overridable Property Address As String
            Public Overridable Property Country As String
            Public Overridable Property DateOfBirth As String
            Public Overridable Property Nationality As String
            Public Overridable Property Reference As String
        End Class

        Public Partial Class SearchListItem
            Public Sub New()
                SearchSources = New List(Of SearchSource)
            End Sub

            Public Overridable Property Id As Long
            Public Overridable Property SearchType As String
            Public Overridable Property DateSearched As Date
            Public Overridable Property DateUpdated As Date
            Public Overridable Property DateArchived As Nullable(Of Date)
            Public Overridable Property IsArchived As Boolean
            Public Overridable Property NumOfResults As Integer
            Public Overridable Property ClientInResults As Boolean
            Public Overridable Property ClientNotInResults As Boolean
            Public Overridable Property AffectedByUpdate As Boolean
            Public Overridable Property SearchCriteria As SearchCriteria
            Public Overridable Property SearchSources As List(Of SearchSource)
        End Class

        Public Partial Class SearchSource
            Public Overridable Property ListId As String
            Public Overridable Property ListName As String
            Public Overridable Property ListShortName As String
            Public Overridable Property IsAffectedByListUpdate As Nullable(Of Boolean)
        End Class
    End Namespace
End Namespace

VB.NET GetSearches 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 /sanctions/list HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetSearches 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>
    <FilterReference>String</FilterReference>
    <FilterType>String</FilterType>
    <FilterUserName>String</FilterUserName>
    <IncludeSearchSourcesFull>false</IncludeSearchSourcesFull>
    <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>
</GetSearches>

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

<GetSearchesResponse 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>
        <DateSearched>0001-01-01T00:00:00</DateSearched>
        <DateUpdated>0001-01-01T00:00:00</DateUpdated>
        <Id>0</Id>
        <IsArchived>false</IsArchived>
        <NumOfResults>0</NumOfResults>
        <SearchCriteria>
          <Address>String</Address>
          <Country>String</Country>
          <DateOfBirth>String</DateOfBirth>
          <Name>String</Name>
          <Nationality>String</Nationality>
          <Reference>String</Reference>
        </SearchCriteria>
        <SearchSources>
          <SearchSource>
            <IsAffectedByListUpdate>false</IsAffectedByListUpdate>
            <ListId>String</ListId>
            <ListName>String</ListName>
            <ListShortName>String</ListShortName>
          </SearchSource>
        </SearchSources>
        <SearchType>String</SearchType>
      </SearchRecord>
    </SearchRecords>
    <TotalSearchRecords>0</TotalSearchRecords>
  </Data>
</GetSearchesResponse>