| POST | /peps/list | Get all PEP searches |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@DataContract
public static class GetPepSearches extends BaseRequest
{
@DataMember
public GetPepSearchesRequest request = null;
public GetPepSearchesRequest getRequest() { return request; }
public GetPepSearches setRequest(GetPepSearchesRequest 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 GetPepSearchesRequest
{
/**
* If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
*/
@ApiMember(Description="If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view")
public String subUserName = null;
public Boolean listUnresolvedSearches = null;
public Boolean listUpdatedSearches = null;
public Boolean listArchivedSearches = null;
public Integer page = null;
public String sortOrder = null;
public String nameSearch = null;
public Boolean nameSearchExact = null;
public String filterReference = null;
public String filterPepType = null;
public String filterType = null;
public Date filterDateFrom = null;
public Date filterDateTo = null;
/**
* If set, will only return searches created by the user
*/
@ApiMember(Description="If set, will only return searches created by the user")
public String filterUserName = null;
public String getSubUserName() { return subUserName; }
public GetPepSearchesRequest setSubUserName(String value) { this.subUserName = value; return this; }
public Boolean isListUnresolvedSearches() { return listUnresolvedSearches; }
public GetPepSearchesRequest setListUnresolvedSearches(Boolean value) { this.listUnresolvedSearches = value; return this; }
public Boolean isListUpdatedSearches() { return listUpdatedSearches; }
public GetPepSearchesRequest setListUpdatedSearches(Boolean value) { this.listUpdatedSearches = value; return this; }
public Boolean isListArchivedSearches() { return listArchivedSearches; }
public GetPepSearchesRequest setListArchivedSearches(Boolean value) { this.listArchivedSearches = value; return this; }
public Integer getPage() { return page; }
public GetPepSearchesRequest setPage(Integer value) { this.page = value; return this; }
public String getSortOrder() { return sortOrder; }
public GetPepSearchesRequest setSortOrder(String value) { this.sortOrder = value; return this; }
public String getNameSearch() { return nameSearch; }
public GetPepSearchesRequest setNameSearch(String value) { this.nameSearch = value; return this; }
public Boolean isNameSearchExact() { return nameSearchExact; }
public GetPepSearchesRequest setNameSearchExact(Boolean value) { this.nameSearchExact = value; return this; }
public String getFilterReference() { return filterReference; }
public GetPepSearchesRequest setFilterReference(String value) { this.filterReference = value; return this; }
public String getFilterPepType() { return filterPepType; }
public GetPepSearchesRequest setFilterPepType(String value) { this.filterPepType = value; return this; }
public String getFilterType() { return filterType; }
public GetPepSearchesRequest setFilterType(String value) { this.filterType = value; return this; }
public Date getFilterDateFrom() { return filterDateFrom; }
public GetPepSearchesRequest setFilterDateFrom(Date value) { this.filterDateFrom = value; return this; }
public Date getFilterDateTo() { return filterDateTo; }
public GetPepSearchesRequest setFilterDateTo(Date value) { this.filterDateTo = value; return this; }
public String getFilterUserName() { return filterUserName; }
public GetPepSearchesRequest setFilterUserName(String value) { this.filterUserName = value; return this; }
}
@DataContract
public static class GetPepSearchesResponse
{
@DataMember
public GetPepSearchesData data = null;
public GetPepSearchesData getData() { return data; }
public GetPepSearchesResponse setData(GetPepSearchesData value) { this.data = value; return this; }
}
public static class GetPepSearchesData extends BaseResponse
{
public Integer totalSearchRecords = null;
public Integer currentPageNum = null;
public Integer maxPageNum = null;
public ArrayOfPepSearchListItem searchRecords = null;
public Integer getTotalSearchRecords() { return totalSearchRecords; }
public GetPepSearchesData setTotalSearchRecords(Integer value) { this.totalSearchRecords = value; return this; }
public Integer getCurrentPageNum() { return currentPageNum; }
public GetPepSearchesData setCurrentPageNum(Integer value) { this.currentPageNum = value; return this; }
public Integer getMaxPageNum() { return maxPageNum; }
public GetPepSearchesData setMaxPageNum(Integer value) { this.maxPageNum = value; return this; }
public ArrayOfPepSearchListItem getSearchRecords() { return searchRecords; }
public GetPepSearchesData setSearchRecords(ArrayOfPepSearchListItem value) { this.searchRecords = 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 ArrayOfPepSearchListItem extends ArrayList<PepSearchListItem>
{
}
public static class PepSearchListItem
{
public Long id = null;
public String searchType = null;
public Date dateSearched = null;
public Date dateUpdated = null;
public Date dateRenewal = null;
public Date dateArchived = null;
public Boolean isArchived = null;
public Integer numOfResults = null;
public Boolean clientInResults = null;
public Boolean clientNotInResults = null;
public Boolean affectedByUpdate = null;
public Boolean isDayOneSearch = null;
public SearchCriteria searchCriteria = null;
public Long getId() { return id; }
public PepSearchListItem setId(Long value) { this.id = value; return this; }
public String getSearchType() { return searchType; }
public PepSearchListItem setSearchType(String value) { this.searchType = value; return this; }
public Date getDateSearched() { return dateSearched; }
public PepSearchListItem setDateSearched(Date value) { this.dateSearched = value; return this; }
public Date getDateUpdated() { return dateUpdated; }
public PepSearchListItem setDateUpdated(Date value) { this.dateUpdated = value; return this; }
public Date getDateRenewal() { return dateRenewal; }
public PepSearchListItem setDateRenewal(Date value) { this.dateRenewal = value; return this; }
public Date getDateArchived() { return dateArchived; }
public PepSearchListItem setDateArchived(Date value) { this.dateArchived = value; return this; }
public Boolean getIsArchived() { return isArchived; }
public PepSearchListItem setIsArchived(Boolean value) { this.isArchived = value; return this; }
public Integer getNumOfResults() { return numOfResults; }
public PepSearchListItem setNumOfResults(Integer value) { this.numOfResults = value; return this; }
public Boolean isClientInResults() { return clientInResults; }
public PepSearchListItem setClientInResults(Boolean value) { this.clientInResults = value; return this; }
public Boolean isClientNotInResults() { return clientNotInResults; }
public PepSearchListItem setClientNotInResults(Boolean value) { this.clientNotInResults = value; return this; }
public Boolean isAffectedByUpdate() { return affectedByUpdate; }
public PepSearchListItem setAffectedByUpdate(Boolean value) { this.affectedByUpdate = value; return this; }
public Boolean getIsDayOneSearch() { return isDayOneSearch; }
public PepSearchListItem setIsDayOneSearch(Boolean value) { this.isDayOneSearch = value; return this; }
public SearchCriteria getSearchCriteria() { return searchCriteria; }
public PepSearchListItem setSearchCriteria(SearchCriteria value) { this.searchCriteria = value; return this; }
}
public static class SearchCriteria
{
public String name = null;
public String address = null;
public String country = null;
public String dateOfBirth = null;
public String nationality = null;
public String reference = null;
public String getName() { return name; }
public SearchCriteria setName(String value) { this.name = value; return this; }
public String getAddress() { return address; }
public SearchCriteria setAddress(String value) { this.address = value; return this; }
public String getCountry() { return country; }
public SearchCriteria setCountry(String value) { this.country = value; return this; }
public String getDateOfBirth() { return dateOfBirth; }
public SearchCriteria setDateOfBirth(String value) { this.dateOfBirth = value; return this; }
public String getNationality() { return nationality; }
public SearchCriteria setNationality(String value) { this.nationality = value; return this; }
public String getReference() { return reference; }
public SearchCriteria setReference(String value) { this.reference = value; return this; }
}
}
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 /peps/list HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","listUnresolvedSearches":false,"listUpdatedSearches":false,"listArchivedSearches":false,"page":0,"sortOrder":"String","nameSearch":"String","nameSearchExact":false,"filterReference":"String","filterPepType":"String","filterType":"String","filterDateFrom":"\/Date(-62135596800000-0000)\/","filterDateTo":"\/Date(-62135596800000-0000)\/","filterUserName":"String"},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"totalSearchRecords":0,"currentPageNum":0,"maxPageNum":0,"searchRecords":[{"id":0,"searchType":"String","dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","dateRenewal":"\/Date(-62135596800000-0000)\/","dateArchived":"\/Date(-62135596800000-0000)\/","isArchived":false,"numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"isDayOneSearch":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"}}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}