Sanctions Search API: v2

GetBulkSearchStatus

Bulk Search

The following routes are available for this service:
POST	/bulksearch/status	Get a bulk search status

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


@DataContract
open class GetBulkSearchStatus : BaseRequest()
{
    @DataMember
    var request:GetBulkSearchStatusRequest? = 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 GetBulkSearchStatusRequest
{
    var bulkSearchId:Int? = null
    var subUserName:String? = null
}

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

open class GetBulkSearchStatusData : BaseResponse()
{
    var bulkSearchStatus:BulkSearchStatus? = 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 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 GetBulkSearchStatus 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 /bulksearch/status HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"bulkSearchId":0,"subUserName":"String"},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

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