Sanctions Search API: v2

GetDbsSearches

DBS

The following routes are available for this service:
GET	/dbs	Get all DBS Searches

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SanctionsSearch.Api2.ServiceModel.Operations.DbsSearches
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 PagedRequest
            Inherits BaseRequest
            '''<Summary>
            '''The maximum number of records to be returned in one page
            '''</Summary>
            <DataMember(Name:="page[limit]")>
            <ApiMember(Description:="The maximum number of records to be returned in one page", ParameterType:="query")>
            Public Overridable Property PageLimit As Integer

            '''<Summary>
            '''The starting point in the list of records from where the data should be fetched. Zero based index.
            '''</Summary>
            <DataMember(Name:="page[offset]")>
            <ApiMember(Description:="The starting point in the list of records from where the data should be fetched. Zero based index.", ParameterType:="query")>
            Public Overridable Property PageOffset As Integer

            '''<Summary>
            '''The term to determine the order in which the data is returned
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The term to determine the order in which the data is returned", ParameterType:="query")>
            Public Overridable Property Sort As String
        End Class

        Public Partial Class PagedResponse(Of T)
            Inherits BaseResponse
            '''<Summary>
            '''The response Metadata
            '''</Summary>
            <ApiMember(Description:="The response Metadata")>
            Public Overridable Property Meta As Meta(Of T)
        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.DbsSearches

        <DataContract>
        Public Partial Class GetDbsSearches
            Inherits PagedRequest
            '''<Summary>
            '''Filter the results to those that have a Name including the specified value
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Filter the results to those that have a Name including the specified value", ParameterType:="query")>
            Public Overridable Property Name As String

            '''<Summary>
            '''Filter the results to those that were created after (or on) this date
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Filter the results to those that were created after (or on) this date", ParameterType:="query")>
            Public Overridable Property DateFrom As Nullable(Of Date)

            '''<Summary>
            '''Filter the results to those that were created before this date
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Filter the results to those that were created before this date", ParameterType:="query")>
            Public Overridable Property DateTo As Nullable(Of Date)

            '''<Summary>
            '''Filter the results to those where the applicant has provided their information (true), or not (false), or either (null)
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Filter the results to those where the applicant has provided their information (true), or not (false), or either (null)", ParameterType:="query")>
            Public Overridable Property IsApplicantInfoCompleted As Nullable(Of Boolean)

            '''<Summary>
            '''Filter the results to those where the ID Checker has verified the applicant's ID (true), or not (false), or either (null)
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Filter the results to those where the ID Checker has verified the applicant's ID (true), or not (false), or either (null)", ParameterType:="query")>
            Public Overridable Property IsIdCheckCompleted As Nullable(Of Boolean)

            '''<Summary>
            '''Filter the results to those where the application is complete and ready to be submitted (true), or not (false), or either (null)
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Filter the results to those where the application is complete and ready to be submitted (true), or not (false), or either (null)", ParameterType:="query")>
            Public Overridable Property IsApplicationCompleted As Nullable(Of Boolean)

            '''<Summary>
            '''Filter the results to those where the application has been submitted (true), or not (false), or either (null)
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Filter the results to those where the application has been submitted (true), or not (false), or either (null)", ParameterType:="query")>
            Public Overridable Property IsApplicationSubmitted As Nullable(Of Boolean)

            '''<Summary>
            '''Filter the results to those where the application has been disclosed (true), or not (false), or either (null)
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Filter the results to those where the application has been disclosed (true), or not (false), or either (null)", ParameterType:="query")>
            Public Overridable Property IsApplicationDisclosed As Nullable(Of Boolean)

            '''<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>
            <DataMember>
            <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", ParameterType:="query")>
            Public Overridable Property SubUserName As String
        End Class

        Public Partial Class GetDbsSearchesData
            Inherits PagedResponse(Of GetDbsSearches)
            Public Overridable Property Searches As ArrayOfDbsSearchShort
        End Class

        <DataContract>
        Public Partial Class GetDbsSearchesResponse
            <DataMember>
            Public Overridable Property Data As GetDbsSearchesData
        End Class
    End Namespace

    Namespace SanctionsSearch.Api2.ServiceModel.Types

        Public Partial Class ArrayOfDbsSearchShort
            Inherits List(Of DbsSearchShort)
        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 DbsSearchShort
            Public Overridable Property Id As Long
            Public Overridable Property DateSearched As Date
            Public Overridable Property DateUpdated As Date
            Public Overridable Property Status As String
            Public Overridable Property DisclosureStatus As String
            Public Overridable Property IsApplicantInfoCompleted As Boolean
            Public Overridable Property IsIdCheckCompleted As Boolean
            Public Overridable Property IsApplicationCompleted As Boolean
            Public Overridable Property IsApplicationSubmitted As Boolean
            Public Overridable Property IsApplicationDisclosed As Boolean
            Public Overridable Property DisclosureLevel As String
            Public Overridable Property Name As String
            Public Overridable Property Reference As String
        End Class

        Public Partial Class Links
            <ApiMember>
            Public Overridable Property Self As String
        End Class

        Public Partial Class Meta(Of T)
            '''<Summary>
            '''Pagination links
            '''</Summary>
            <ApiMember(Description:="Pagination links")>
            Public Overridable Property Links As MetaLinks

            '''<Summary>
            '''The total number of records for the query
            '''</Summary>
            <ApiMember(Description:="The total number of records for the query")>
            Public Overridable Property TotalCount As Nullable(Of Integer)

            '''<Summary>
            '''The maximum number of records to be returned in one page
            '''</Summary>
            <ApiMember(Description:="The maximum number of records to be returned in one page")>
            Public Overridable Property PageLimit As Nullable(Of Integer)

            '''<Summary>
            '''The starting point in the list of records from where the data should be fetched. Zero based index.
            '''</Summary>
            <ApiMember(Description:="The starting point in the list of records from where the data should be fetched. Zero based index.")>
            Public Overridable Property PageOffset As Nullable(Of Integer)
        End Class

        Public Partial Class MetaLinks
            Inherits Links
            '''<Summary>
            '''The link to the first page of records
            '''</Summary>
            <ApiMember(Description:="The link to the first page of records")>
            Public Overridable Property First As String

            '''<Summary>
            '''The link to the last page of records
            '''</Summary>
            <ApiMember(Description:="The link to the last page of records")>
            Public Overridable Property Last As String

            '''<Summary>
            '''The link to the next page of records, if applicable
            '''</Summary>
            <ApiMember(Description:="The link to the next page of records, if applicable")>
            Public Overridable Property Next As String

            '''<Summary>
            '''The link to the last page of records, if applicable
            '''</Summary>
            <ApiMember(Description:="The link to the last page of records, if applicable")>
            Public Overridable Property Prev As String
        End Class
    End Namespace
End Namespace

VB.NET GetDbsSearches 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.

GET /dbs HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml

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

<GetDbsSearchesResponse 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>
    <Meta>
      <Links>
        <Self>String</Self>
        <First>String</First>
        <Last>String</Last>
        <Next>String</Next>
        <Prev>String</Prev>
      </Links>
      <PageLimit>0</PageLimit>
      <PageOffset>0</PageOffset>
      <TotalCount>0</TotalCount>
    </Meta>
    <Searches>
      <SearchRecord>
        <DateSearched>0001-01-01T00:00:00</DateSearched>
        <DateUpdated>0001-01-01T00:00:00</DateUpdated>
        <DisclosureLevel>String</DisclosureLevel>
        <DisclosureStatus>String</DisclosureStatus>
        <Id>0</Id>
        <IsApplicantInfoCompleted>false</IsApplicantInfoCompleted>
        <IsApplicationCompleted>false</IsApplicationCompleted>
        <IsApplicationDisclosed>false</IsApplicationDisclosed>
        <IsApplicationSubmitted>false</IsApplicationSubmitted>
        <IsIdCheckCompleted>false</IsIdCheckCompleted>
        <Name>String</Name>
        <Reference>String</Reference>
        <Status>String</Status>
      </SearchRecord>
    </Searches>
  </Data>
</GetDbsSearchesResponse>