| 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 .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetBulkSearchHistory
<?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>
<GetBulkSearchHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<WhereUserId>String</WhereUserId>
</Request>
</GetBulkSearchHistory>
</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>
<GetBulkSearchHistoryResponse 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>
<BulkSearchList>
<BulkSearch>
<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>
</BulkSearch>
</BulkSearchList>
<CurrentPageNum>0</CurrentPageNum>
<MaxPageNum>0</MaxPageNum>
<PageSize>0</PageSize>
<TotalBulkSearches>0</TotalBulkSearches>
</Data>
</GetBulkSearchHistoryResponse>
</soap:Body>
</soap:Envelope>