Sanctions Search API: v1

<back to all web services

UpdateSearchStatus

Update/resolve a sanctions search

// @DataContract
export class ResponseError
{
    // @DataMember(Order=1)
    public ErrorCode: string;

    // @DataMember(Order=2)
    public FieldName: string;

    // @DataMember(Order=3)
    public Message: string;

    public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}

export class ArrayOfResponseError extends Array<ResponseError>
{

    public constructor(init?: Partial<ArrayOfResponseError>) { super(); (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public ErrorCode: string;

    // @DataMember(Order=2)
    public Message: string;

    // @DataMember(Order=3)
    public StackTrace: string;

    // @DataMember(Order=4)
    public Errors: ArrayOfResponseError;

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

// @DataContract
export class UpdateSearchStatusData implements IBaseDataResponse, IHasResponseStatus
{
    /** @description Response status object */
    // @DataMember
    // @ApiMember(DataType="ResponseStatus", Description="Response status object")
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<UpdateSearchStatusData>) { (Object as any).assign(this, init); }
}

// @DataContract
export class UpdateSearchStatusResponse
{
    /** @description Response object */
    // @DataMember
    // @ApiMember(DataType="UpdateSearchStatusData", Description="Response object")
    public Data: UpdateSearchStatusData;

    public constructor(init?: Partial<UpdateSearchStatusResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Authentication implements IAuthentication
{
    /** @description 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 ApiUserId: string;

    /** @description 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 ApiUserKey: string;

    public constructor(init?: Partial<Authentication>) { (Object as any).assign(this, init); }
}

// @DataContract
export class UpdateSearchStatusRequest
{
    /** @description 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 Id: number;

    /** @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. */
    // @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 ClientInResults: 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. */
    // @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 ClientNotInResults: boolean;

    public constructor(init?: Partial<UpdateSearchStatusRequest>) { (Object as any).assign(this, init); }
}

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

    /** @description Request object */
    // @DataMember
    // @ApiMember(DataType="UpdateSearchStatusRequest", Description="Request object", IsRequired=true)
    public Request: UpdateSearchStatusRequest;

    public constructor(init?: Partial<UpdateSearchStatus>) { (Object as any).assign(this, init); }
}

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