| POST | /bulksearches/list | Get all bulk searches |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@DataContract
public static class GetBulkSearchHistory extends BaseRequest
{
@DataMember
public GetBulkSearchHistoryRequest request = null;
public GetBulkSearchHistoryRequest getRequest() { return request; }
public GetBulkSearchHistory setRequest(GetBulkSearchHistoryRequest value) { this.request = value; return this; }
}
@DataContract
public static class BaseRequest implements IBaseRequest
{
/**
* The authentication credentials
*/
@DataMember
@ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
public Authentication authentication = null;
public Authentication getAuthentication() { return authentication; }
public BaseRequest setAuthentication(Authentication value) { this.authentication = value; return this; }
}
@DataContract
public static class Authentication
{
/**
* The API User ID provided by us when you signed up to use our API
*/
@DataMember
@ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
public String apiUserId = null;
/**
* The API User Key provided by us when you signed up to use our API
*/
@DataMember
@ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
public String apiUserKey = null;
public String getApiUserId() { return apiUserId; }
public Authentication setApiUserId(String value) { this.apiUserId = value; return this; }
public String getApiUserKey() { return apiUserKey; }
public Authentication setApiUserKey(String value) { this.apiUserKey = value; return this; }
}
public static class GetBulkSearchHistoryRequest
{
public String subUserName = null;
public Integer page = null;
public String sortOrder = null;
/**
* The user id to filter on, in string format (GUID)
*/
@ApiMember(Description="The user id to filter on, in string format (GUID)")
public String whereUserId = null;
public Date whereDateFrom = null;
public Date whereDateTo = null;
public Integer whereId = null;
public Integer pageSize = null;
public String getSubUserName() { return subUserName; }
public GetBulkSearchHistoryRequest setSubUserName(String value) { this.subUserName = value; return this; }
public Integer getPage() { return page; }
public GetBulkSearchHistoryRequest setPage(Integer value) { this.page = value; return this; }
public String getSortOrder() { return sortOrder; }
public GetBulkSearchHistoryRequest setSortOrder(String value) { this.sortOrder = value; return this; }
public String getWhereUserId() { return whereUserId; }
public GetBulkSearchHistoryRequest setWhereUserId(String value) { this.whereUserId = value; return this; }
public Date getWhereDateFrom() { return whereDateFrom; }
public GetBulkSearchHistoryRequest setWhereDateFrom(Date value) { this.whereDateFrom = value; return this; }
public Date getWhereDateTo() { return whereDateTo; }
public GetBulkSearchHistoryRequest setWhereDateTo(Date value) { this.whereDateTo = value; return this; }
public Integer getWhereId() { return whereId; }
public GetBulkSearchHistoryRequest setWhereId(Integer value) { this.whereId = value; return this; }
public Integer getPageSize() { return pageSize; }
public GetBulkSearchHistoryRequest setPageSize(Integer value) { this.pageSize = value; return this; }
}
@DataContract
public static class GetBulkSearchHistoryResponse
{
@DataMember
public GetBulkSearchHistoryData data = null;
public GetBulkSearchHistoryData getData() { return data; }
public GetBulkSearchHistoryResponse setData(GetBulkSearchHistoryData value) { this.data = value; return this; }
}
public static class GetBulkSearchHistoryData extends BaseResponse
{
public ArrayOfBulkSearchStatus bulkSearchList = null;
public Integer currentPageNum = null;
public Integer maxPageNum = null;
public Integer totalBulkSearches = null;
public Integer pageSize = null;
public ArrayOfBulkSearchStatus getBulkSearchList() { return bulkSearchList; }
public GetBulkSearchHistoryData setBulkSearchList(ArrayOfBulkSearchStatus value) { this.bulkSearchList = value; return this; }
public Integer getCurrentPageNum() { return currentPageNum; }
public GetBulkSearchHistoryData setCurrentPageNum(Integer value) { this.currentPageNum = value; return this; }
public Integer getMaxPageNum() { return maxPageNum; }
public GetBulkSearchHistoryData setMaxPageNum(Integer value) { this.maxPageNum = value; return this; }
public Integer getTotalBulkSearches() { return totalBulkSearches; }
public GetBulkSearchHistoryData setTotalBulkSearches(Integer value) { this.totalBulkSearches = value; return this; }
public Integer getPageSize() { return pageSize; }
public GetBulkSearchHistoryData setPageSize(Integer value) { this.pageSize = value; return this; }
}
public static class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
/**
* The status of the response
*/
@ApiMember(Description="The status of the response")
public ResponseStatus responseStatus = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
public static class ArrayOfResponseError extends ArrayList<ResponseError>
{
}
public static class ArrayOfBulkSearchStatus extends ArrayList<BulkSearchStatus>
{
}
public static class BulkSearchStatus
{
public Integer bulkSearchId = null;
public Boolean success = null;
public String status = null;
public Integer total = null;
public String message = null;
public Integer processed = null;
public Boolean isPepSearch = null;
public Boolean isSanctionsSearch = null;
public Integer totalPep = null;
public Integer processedPep = null;
public Integer totalSanctions = null;
public Integer processedSanctions = null;
public Integer getBulkSearchId() { return bulkSearchId; }
public BulkSearchStatus setBulkSearchId(Integer value) { this.bulkSearchId = value; return this; }
public Boolean isSuccess() { return success; }
public BulkSearchStatus setSuccess(Boolean value) { this.success = value; return this; }
public String getStatus() { return status; }
public BulkSearchStatus setStatus(String value) { this.status = value; return this; }
public Integer getTotal() { return total; }
public BulkSearchStatus setTotal(Integer value) { this.total = value; return this; }
public String getMessage() { return message; }
public BulkSearchStatus setMessage(String value) { this.message = value; return this; }
public Integer getProcessed() { return processed; }
public BulkSearchStatus setProcessed(Integer value) { this.processed = value; return this; }
public Boolean getIsPepSearch() { return isPepSearch; }
public BulkSearchStatus setIsPepSearch(Boolean value) { this.isPepSearch = value; return this; }
public Boolean getIsSanctionsSearch() { return isSanctionsSearch; }
public BulkSearchStatus setIsSanctionsSearch(Boolean value) { this.isSanctionsSearch = value; return this; }
public Integer getTotalPep() { return totalPep; }
public BulkSearchStatus setTotalPep(Integer value) { this.totalPep = value; return this; }
public Integer getProcessedPep() { return processedPep; }
public BulkSearchStatus setProcessedPep(Integer value) { this.processedPep = value; return this; }
public Integer getTotalSanctions() { return totalSanctions; }
public BulkSearchStatus setTotalSanctions(Integer value) { this.totalSanctions = value; return this; }
public Integer getProcessedSanctions() { return processedSanctions; }
public BulkSearchStatus setProcessedSanctions(Integer value) { this.processedSanctions = value; return this; }
}
}
Java 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"}}}}