Sanctions Search API: v2

<back to all web services

AddBulkSearch

Bulk Search
The following routes are available for this service:
POST/bulksearches/createCreate a bulk search
"use strict";
export class Authentication {
    /** @param {{apiUserId?:string,apiUserKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API User ID provided by us when you signed up to use our API */
    apiUserId;
    /**
     * @type {string}
     * @description The API User Key provided by us when you signed up to use our API */
    apiUserKey;
}
export class BaseRequest {
    /** @param {{authentication?:Authentication}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Authentication}
     * @description The authentication credentials */
    authentication;
}
export class ResponseError {
    /** @param {{errorCode?:string,fieldName?:string,message?:string,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    fieldName;
    /** @type {string} */
    message;
    /** @type {{ [index: string]: string; }} */
    meta;
}
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,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    message;
    /** @type {string} */
    stackTrace;
    /** @type {ArrayOfResponseError} */
    errors;
    /** @type {{ [index: string]: string; }} */
    meta;
}
export class BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {ResponseStatus}
     * @description The status of the response */
    responseStatus;
}
export class BulkSearchStatus {
    /** @param {{bulkSearchId?:number,success?:boolean,status?:string,total?:number,message?:string,processed?:number,isPepSearch?:boolean,isSanctionsSearch?:boolean,totalPep?:number,processedPep?:number,totalSanctions?:number,processedSanctions?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    bulkSearchId;
    /** @type {boolean} */
    success;
    /** @type {string} */
    status;
    /** @type {number} */
    total;
    /** @type {string} */
    message;
    /** @type {number} */
    processed;
    /** @type {boolean} */
    isPepSearch;
    /** @type {boolean} */
    isSanctionsSearch;
    /** @type {number} */
    totalPep;
    /** @type {number} */
    processedPep;
    /** @type {number} */
    totalSanctions;
    /** @type {number} */
    processedSanctions;
}
export class AddBulkSearchData extends BaseResponse {
    /** @param {{bulkSearchStatus?:BulkSearchStatus,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {BulkSearchStatus} */
    bulkSearchStatus;
}
export class AddBulkSearchResponse {
    /** @param {{data?:AddBulkSearchData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AddBulkSearchData} */
    data;
}
export class ArrayOfLists extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class AddBulkSearchRequest {
    /** @param {{isSanctionsSearch?:boolean,isPepSearch?:boolean,type?:string,selectedLists?:ArrayOfLists}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    isSanctionsSearch;
    /** @type {boolean} */
    isPepSearch;
    /** @type {string} */
    type;
    /** @type {ArrayOfLists} */
    selectedLists;
}
export class AddBulkSearch extends BaseRequest {
    /** @param {{request?:AddBulkSearchRequest,authentication?:Authentication}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {AddBulkSearchRequest} */
    request;
}

JavaScript AddBulkSearch DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /bulksearches/create HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddBulkSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <IsPepSearch>false</IsPepSearch>
    <IsSanctionsSearch>false</IsSanctionsSearch>
    <SelectedLists>
      <ListId>String</ListId>
    </SelectedLists>
    <Type>String</Type>
  </Request>
</AddBulkSearch>

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

<AddBulkSearchResponse 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>
    <BulkSearchStatus>
      <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>
    </BulkSearchStatus>
  </Data>
</AddBulkSearchResponse>