Sanctions Search API: v1

<back to all web services

UpdateSearchStatus

Update/resolve a sanctions search

"use strict";
export class ResponseError {
    /** @param {{ErrorCode?:string,FieldName?:string,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    FieldName;
    /** @type {string} */
    Message;
}
export class ArrayOfResponseError extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class ResponseStatus {
    /** @param {{ErrorCode?:string,Message?:string,StackTrace?:string,Errors?:ArrayOfResponseError}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    Message;
    /** @type {string} */
    StackTrace;
    /** @type {ArrayOfResponseError} */
    Errors;
}
export class UpdateSearchStatusData {
    /** @param {{ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {ResponseStatus}
     * @description Response status object */
    ResponseStatus;
}
export class UpdateSearchStatusResponse {
    /** @param {{Data?:UpdateSearchStatusData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {UpdateSearchStatusData}
     * @description Response object */
    Data;
}
export class Authentication {
    /** @param {{ApiUserId?:string,ApiUserKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API User ID that will authenticate your request */
    ApiUserId;
    /**
     * @type {string}
     * @description The API User Key that will authenticate your request */
    ApiUserKey;
}
export class UpdateSearchStatusRequest {
    /** @param {{Id?:number,ClientInResults?:boolean,ClientNotInResults?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The ID of the sanctions search that is being resolved/updated. */
    Id;
    /**
     * @type {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. */
    ClientInResults;
    /**
     * @type {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. */
    ClientNotInResults;
}
export class UpdateSearchStatus {
    /** @param {{Authentication?:Authentication,Request?:UpdateSearchStatusRequest}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Authentication}
     * @description Authentication object */
    Authentication;
    /**
     * @type {UpdateSearchStatusRequest}
     * @description Request object */
    Request;
}

JavaScript UpdateSearchStatus DTOs

POST /soap11 HTTP/1.1 
Host: api.sanctionssearch.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: UpdateSearchStatus

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap: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>

</soap:Body>
</soap:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap: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>

</soap:Body>
</soap:Envelope>