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.*;

public class dtos
{

    /**
    * 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
    public static class UpdateSearchStatus implements IBaseRequest
    {
        /**
        * Authentication object
        */
        @DataMember
        @ApiMember(DataType="Authentication", Description="Authentication object", IsRequired=true)
        public Authentication Authentication = null;

        /**
        * Request object
        */
        @DataMember
        @ApiMember(DataType="UpdateSearchStatusRequest", Description="Request object", IsRequired=true)
        public UpdateSearchStatusRequest Request = null;
        
        public Authentication getAuthentication() { return Authentication; }
        public UpdateSearchStatus setAuthentication(Authentication value) { this.Authentication = value; return this; }
        public UpdateSearchStatusRequest getRequest() { return Request; }
        public UpdateSearchStatus setRequest(UpdateSearchStatusRequest value) { this.Request = value; return this; }
    }

    @DataContract
    public static class Authentication implements 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)
        public String ApiUserId = 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)
        public String ApiUserKey = null;
        
        public String getApiUserId() { return ApiUserId; }
        public Authentication setApiUserId(String value) { this.ApiUserId = value; return this; }
        public String getApiUserKey() { return ApiUserKey; }
        public Authentication setApiUserKey(String value) { this.ApiUserKey = value; return this; }
    }

    @DataContract
    public static 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)
        public Long Id = 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)
        public Boolean ClientInResults = 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)
        public Boolean ClientNotInResults = null;
        
        public Long getId() { return Id; }
        public UpdateSearchStatusRequest setId(Long value) { this.Id = value; return this; }
        public Boolean isClientInResults() { return ClientInResults; }
        public UpdateSearchStatusRequest setClientInResults(Boolean value) { this.ClientInResults = value; return this; }
        public Boolean isClientNotInResults() { return ClientNotInResults; }
        public UpdateSearchStatusRequest setClientNotInResults(Boolean value) { this.ClientNotInResults = value; return this; }
    }

    @DataContract
    public static class UpdateSearchStatusResponse
    {
        /**
        * Response object
        */
        @DataMember
        @ApiMember(DataType="UpdateSearchStatusData", Description="Response object")
        public UpdateSearchStatusData Data = null;
        
        public UpdateSearchStatusData getData() { return Data; }
        public UpdateSearchStatusResponse setData(UpdateSearchStatusData value) { this.Data = value; return this; }
    }

    @DataContract
    public static class UpdateSearchStatusData implements IBaseDataResponse, IHasResponseStatus
    {
        /**
        * Response status object
        */
        @DataMember
        @ApiMember(DataType="ResponseStatus", Description="Response status object")
        public ResponseStatus ResponseStatus = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public UpdateSearchStatusData setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ArrayOfResponseError extends ArrayList<ResponseError>
    {
        
    }

}

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