Sanctions Search API: v1

GetListSearches

Sanctions

The following routes are available for this service:
POST	/searches/list	Get all sanctions searches

import Foundation
import ServiceStack

// @ApiResponse(Description="Your request is successful if the \"<em>Data.ResponseStatus.Message</em>\" field is \"<b>Success</b>\".", StatusCode=200)
// @DataContract
public class GetListSearches : IBaseRequest, Codable
{
    // @DataMember
    public var authentication:Authentication

    // @DataMember
    public var page:Int

    // @DataMember
    public var sortOrder:String

    // @DataMember
    public var nameSearch:String

    required public init(){}
}

// @DataContract
public class Authentication : IAuthentication, Codable
{
    /**
    * The API User ID that will authenticate your request
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The API User ID that will authenticate your request", IsRequired=true)
    public var apiUserId:String

    /**
    * The API User Key that will authenticate your request
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="The API User Key that will authenticate your request", IsRequired=true)
    public var apiUserKey:String

    required public init(){}
}

// @DataContract
public class GetListSearchesResponse : Codable
{
    // @DataMember
    public var data:GetListSearchesData

    required public init(){}
}

// @DataContract
public class GetListSearchesData : IBaseDataResponse, IHasResponseStatus, Codable
{
    // @DataMember
    public var responseStatus:ResponseStatus

    // @DataMember
    public var totalSearchRecords:Int

    // @DataMember
    public var currentPageNum:Int

    // @DataMember
    public var maxPageNum:Int

    // @DataMember
    public var searchRecords:ArrayOfSearchListItem

    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 numOfResults:Int
    public var clientInResults:Bool
    public var clientNotInResults:Bool
    public var affectedByUpdate:Bool
    public var searchCriteria:SearchCriteria

    required public init(){}
}

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

    required public init(){}
}

Swift GetListSearches DTOs

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

HTTP + JSON

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

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

{"Authentication":{"ApiUserId":"String","ApiUserKey":"String"},"Page":0,"SortOrder":"String","NameSearch":"String"}

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

{"Data":{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String"}]},"TotalSearchRecords":0,"CurrentPageNum":0,"MaxPageNum":0,"SearchRecords":[{"Id":0,"SearchType":"String","DateSearched":"\/Date(-62135596800000-0000)\/","DateUpdated":"\/Date(-62135596800000-0000)\/","NumOfResults":0,"ClientInResults":false,"ClientNotInResults":false,"AffectedByUpdate":false,"SearchCriteria":{"Name":"String","DateOfBirth":"String","CountryOfBirth":"String","Nationality":"String","Address":"String"}}]}}