POST | /bulksearches/list | Get all bulk searches |
---|
"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 ArrayOfBulkSearchStatus extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class GetBulkSearchHistoryData extends BaseResponse {
/** @param {{bulkSearchList?:ArrayOfBulkSearchStatus,currentPageNum?:number,maxPageNum?:number,totalBulkSearches?:number,pageSize?:number,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {ArrayOfBulkSearchStatus} */
bulkSearchList;
/** @type {number} */
currentPageNum;
/** @type {number} */
maxPageNum;
/** @type {number} */
totalBulkSearches;
/** @type {number} */
pageSize;
}
export class GetBulkSearchHistoryResponse {
/** @param {{data?:GetBulkSearchHistoryData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {GetBulkSearchHistoryData} */
data;
}
export class GetBulkSearchHistoryRequest {
/** @param {{subUserName?:string,page?:number,sortOrder?:string,whereUserId?:string,whereDateFrom?:string,whereDateTo?:string,whereId?:number,pageSize?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
subUserName;
/** @type {number} */
page;
/** @type {string} */
sortOrder;
/**
* @type {string}
* @description The user id to filter on, in string format (GUID) */
whereUserId;
/** @type {?string} */
whereDateFrom;
/** @type {?string} */
whereDateTo;
/** @type {?number} */
whereId;
/** @type {number} */
pageSize;
}
export class GetBulkSearchHistory extends BaseRequest {
/** @param {{request?:GetBulkSearchHistoryRequest,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {GetBulkSearchHistoryRequest} */
request;
}
JavaScript GetBulkSearchHistory DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /bulksearches/list HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","page":0,"sortOrder":"String","whereUserId":"String","whereDateFrom":"\/Date(-62135596800000-0000)\/","whereDateTo":"\/Date(-62135596800000-0000)\/","whereId":0,"pageSize":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"data":{"bulkSearchList":[{"bulkSearchId":0,"success":false,"status":"String","total":0,"message":"String","processed":0,"isPepSearch":false,"isSanctionsSearch":false,"totalPep":0,"processedPep":0,"totalSanctions":0,"processedSanctions":0}],"currentPageNum":0,"maxPageNum":0,"totalBulkSearches":0,"pageSize":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}