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
import Foundation
import ServiceStack

// @DataContract
public class GetSearches : BaseRequest
{
    // @DataMember
    public var request:GetSearchesRequest

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case request
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        request = try container.decodeIfPresent(GetSearchesRequest.self, forKey: .request)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if request != nil { try container.encode(request, forKey: .request) }
    }
}

// @DataContract
public class BaseRequest : IBaseRequest, Codable
{
    /**
    * The authentication credentials
    */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public var authentication:Authentication

    required public init(){}
}

// @DataContract
public class Authentication : Codable
{
    /**
    * The API User ID provided by us when you signed up to use our API
    */
    // @DataMember
    // @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public var apiUserId:String

    /**
    * The API User Key provided by us when you signed up to use our API
    */
    // @DataMember
    // @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public var apiUserKey:String

    required public init(){}
}

public class GetSearchesRequest : Codable
{
    /**
    * If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
    */
    // @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 var subUserName:String

    public var listUnresolvedSearches:Bool?
    public var listUpdatedSearches:Bool?
    public var listArchivedSearches:Bool
    public var page:Int
    public var sortOrder:String
    public var nameSearch:String
    public var nameSearchExact:Bool
    public var filterReference:String
    public var filterType:String
    public var filterDateFrom:Date?
    public var filterDateTo:Date?
    /**
    * If set, will only return searches created by the user
    */
    // @ApiMember(Description="If set, will only return searches created by the user")
    public var filterUserName:String

    public var includeSearchSourcesFull:Bool

    required public init(){}
}

// @DataContract
public class GetSearchesResponse : Codable
{
    // @DataMember
    public var data:GetSearchesData

    required public init(){}
}

public class GetSearchesData : BaseResponse
{
    public var totalSearchRecords:Int
    public var currentPageNum:Int
    public var maxPageNum:Int
    public var searchRecords:ArrayOfSearchListItem

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case totalSearchRecords
        case currentPageNum
        case maxPageNum
        case searchRecords
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        totalSearchRecords = try container.decodeIfPresent(Int.self, forKey: .totalSearchRecords)
        currentPageNum = try container.decodeIfPresent(Int.self, forKey: .currentPageNum)
        maxPageNum = try container.decodeIfPresent(Int.self, forKey: .maxPageNum)
        searchRecords = try container.decodeIfPresent(ArrayOfSearchListItem.self, forKey: .searchRecords)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if totalSearchRecords != nil { try container.encode(totalSearchRecords, forKey: .totalSearchRecords) }
        if currentPageNum != nil { try container.encode(currentPageNum, forKey: .currentPageNum) }
        if maxPageNum != nil { try container.encode(maxPageNum, forKey: .maxPageNum) }
        if searchRecords != nil { try container.encode(searchRecords, forKey: .searchRecords) }
    }
}

public class BaseResponse : IBaseDataResponse, IHasResponseStatus, Codable
{
    /**
    * The status of the response
    */
    // @ApiMember(Description="The status of the response")
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ArrayOfResponseError : List<ResponseError>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class ArrayOfSearchListItem : List<SearchListItem>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class SearchListItem : Codable
{
    public var id:Int
    public var searchType:String
    public var dateSearched:Date
    public var dateUpdated:Date
    public var dateArchived:Date?
    public var isArchived:Bool
    public var numOfResults:Int
    public var clientInResults:Bool
    public var clientNotInResults:Bool
    public var affectedByUpdate:Bool
    public var searchCriteria:SearchCriteria
    public var searchSources:[SearchSource] = []

    required public init(){}
}

public class SearchCriteria : Codable
{
    public var name:String
    public var address:String
    public var country:String
    public var dateOfBirth:String
    public var nationality:String
    public var reference:String

    required public init(){}
}

public class SearchSource : Codable
{
    public var listId:String
    public var listName:String
    public var listShortName:String
    public var isAffectedByListUpdate:Bool?

    required public init(){}
}

Swift 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>