Sanctions Search API: v2

<back to all web services

GetBulkSearchHistory

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetBulkSearchHistory : BaseRequest()
{
    @DataMember
    var request:GetBulkSearchHistoryRequest? = null
}

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

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

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

open class GetBulkSearchHistoryRequest
{
    var subUserName:String? = null
    var page:Int? = null
    var sortOrder:String? = null
    /**
    * The user id to filter on, in string format (GUID)
    */
    @ApiMember(Description="The user id to filter on, in string format (GUID)")
    var whereUserId:String? = null

    var whereDateFrom:Date? = null
    var whereDateTo:Date? = null
    var whereId:Int? = null
    var pageSize:Int? = null
}

@DataContract
open class GetBulkSearchHistoryResponse
{
    @DataMember
    @SerializedName("data") var Data:GetBulkSearchHistoryData? = null
}

open class GetBulkSearchHistoryData : BaseResponse()
{
    var bulkSearchList:ArrayOfBulkSearchStatus? = null
    var currentPageNum:Int? = null
    var maxPageNum:Int? = null
    var totalBulkSearches:Int? = null
    var pageSize:Int? = null
}

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

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

open class ArrayOfBulkSearchStatus : ArrayList<BulkSearchStatus>()
{
}

open class BulkSearchStatus
{
    var bulkSearchId:Int? = null
    var success:Boolean? = null
    var status:String? = null
    var total:Int? = null
    var message:String? = null
    var processed:Int? = null
    var isPepSearch:Boolean? = null
    var isSanctionsSearch:Boolean? = null
    var totalPep:Int? = null
    var processedPep:Int? = null
    var totalSanctions:Int? = null
    var processedSanctions:Int? = null
}

Kotlin GetBulkSearchHistory DTOs

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

{"request":{"subUserName":"String","page":0,"sortOrder":"String","whereUserId":"String","whereDateFrom":"\/Date(-62135596800000-0000)\/","whereDateTo":"\/Date(-62135596800000-0000)\/","whereId":0,"pageSize":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"bulkSearchList":[{"bulkSearchId":0,"success":false,"status":"String","total":0,"message":"String","processed":0,"isPepSearch":false,"isSanctionsSearch":false,"totalPep":0,"processedPep":0,"totalSanctions":0,"processedSanctions":0}],"currentPageNum":0,"maxPageNum":0,"totalBulkSearches":0,"pageSize":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}