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 /soap12 HTTP/1.1 
Host: api.sanctionssearch.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

<GetBulkSearchHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <WhereUserId>String</WhereUserId>
  </Request>
</GetBulkSearchHistory>

</soap12:Body>
</soap12:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

<GetBulkSearchHistoryResponse 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>
    <BulkSearchList>
      <BulkSearch>
        <BulkSearchId>0</BulkSearchId>
        <IsPepSearch>false</IsPepSearch>
        <IsSanctionsSearch>false</IsSanctionsSearch>
        <Message>String</Message>
        <Processed>0</Processed>
        <ProcessedPep>0</ProcessedPep>
        <ProcessedSanctions>0</ProcessedSanctions>
        <Status>String</Status>
        <Success>false</Success>
        <Total>0</Total>
        <TotalPep>0</TotalPep>
        <TotalSanctions>0</TotalSanctions>
      </BulkSearch>
    </BulkSearchList>
    <CurrentPageNum>0</CurrentPageNum>
    <MaxPageNum>0</MaxPageNum>
    <PageSize>0</PageSize>
    <TotalBulkSearches>0</TotalBulkSearches>
  </Data>
</GetBulkSearchHistoryResponse>

</soap12:Body>
</soap12:Envelope>