Sanctions Search API: v1

GetListSearches

Sanctions

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

import java.math.*
import java.util.*
import net.servicestack.client.*


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

    @DataMember
    var Page:Int? = null

    @DataMember
    var SortOrder:String? = null

    @DataMember
    var NameSearch:String? = null
}

@DataContract
open class Authentication : IAuthentication
{
    /**
    * 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)
    var ApiUserId:String? = null

    /**
    * 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)
    var ApiUserKey:String? = null
}

@DataContract
open class GetListSearchesResponse
{
    @DataMember
    var Data:GetListSearchesData? = null
}

@DataContract
open class GetListSearchesData : IBaseDataResponse, IHasResponseStatus
{
    @DataMember
    var ResponseStatus:ResponseStatus? = null

    @DataMember
    var TotalSearchRecords:Int? = null

    @DataMember
    var CurrentPageNum:Int? = null

    @DataMember
    var MaxPageNum:Int? = null

    @DataMember
    var SearchRecords:ArrayOfSearchListItem? = null
}

open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}

open class ArrayOfSearchListItem : ArrayList<SearchListItem>()
{
}

open class SearchListItem
{
    var Id:Long? = null
    var SearchType:String? = null
    var DateSearched:Date? = null
    var DateUpdated:Date? = null
    var NumOfResults:Int? = null
    var ClientInResults:Boolean? = null
    var ClientNotInResults:Boolean? = null
    var AffectedByUpdate:Boolean? = null
    var SearchCriteria:SearchCriteria? = null
}

open class SearchCriteria
{
    var Name:String? = null
    var DateOfBirth:String? = null
    var CountryOfBirth:String? = null
    var Nationality:String? = null
    var Address:String? = null
}

Kotlin 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"}}]}}