Sanctions Search API: v1

<back to all web services

UpdateSearchStatus

Update/resolve a sanctions search

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


/**
* Update/resolve a sanctions search
*/
@Api(Description="Update/resolve a sanctions search")
@ApiResponse(Description="Your request is successful if the \"<em>Data.ResponseStatus.Message</em>\" field is \"<b>Success</b>\".", StatusCode=200)
@DataContract
open class UpdateSearchStatus : IBaseRequest
{
    /**
    * Authentication object
    */
    @DataMember
    @ApiMember(DataType="Authentication", Description="Authentication object", IsRequired=true)
    var Authentication:Authentication? = null

    /**
    * Request object
    */
    @DataMember
    @ApiMember(DataType="UpdateSearchStatusRequest", Description="Request object", IsRequired=true)
    var Request:UpdateSearchStatusRequest? = 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 UpdateSearchStatusRequest
{
    /**
    * The ID of the sanctions search that is being resolved/updated.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="The ID of the sanctions search that is being resolved/updated.", Format="int64", IsRequired=true)
    var Id:Long? = null

    /**
    * Whether the search results <b>did</b> contain the client. Set this to "<b>true</b>" if the client <b>WAS</b> found in the search results.
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="Whether the search results <b>did</b> contain the client. Set this to \"<b>true</b>\" if the client <b>WAS</b> found in the search results.", IsRequired=true)
    var ClientInResults:Boolean? = null

    /**
    * Whether the search results <b>did not</b> contain the client. Set this to "<b>true</b>" if the client <b>WAS NOT</b> found in the search results.
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="Whether the search results <b>did not</b> contain the client. Set this to \"<b>true</b>\" if the client <b>WAS NOT</b> found in the search results.", IsRequired=true)
    var ClientNotInResults:Boolean? = null
}

@DataContract
open class UpdateSearchStatusResponse
{
    /**
    * Response object
    */
    @DataMember
    @ApiMember(DataType="UpdateSearchStatusData", Description="Response object")
    var Data:UpdateSearchStatusData? = null
}

@DataContract
open class UpdateSearchStatusData : IBaseDataResponse, IHasResponseStatus
{
    /**
    * Response status object
    */
    @DataMember
    @ApiMember(DataType="ResponseStatus", Description="Response status object")
    var ResponseStatus:ResponseStatus? = null
}

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

Kotlin UpdateSearchStatus 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>

<UpdateSearchStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <ClientInResults>false</ClientInResults>
    <ClientNotInResults>false</ClientNotInResults>
    <Id>0</Id>
  </Request>
</UpdateSearchStatus>

</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>

<UpdateSearchStatusResponse 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>
        </ResponseError>
      </Errors>
    </ResponseStatus>
  </Data>
</UpdateSearchStatusResponse>

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