| 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. Can be provided in the request body, or as a header parameter (X-Api-User)
*/
@DataMember
@ApiMember(Description="The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)", IsRequired=true, ParameterType="header, body")
public String apiUserId = null;
/**
* The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
*/
@DataMember
@ApiMember(Description="The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)", IsRequired=true, ParameterType="header, body")
public String apiUserKey = null;
/**
* The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).
*/
@DataMember
@ApiMember(Description="The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).", ParameterType="header, body")
public String userId = 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 String getUserId() { return userId; }
public Authentication setUserId(String value) { this.userId = 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 listExpiringSearches = null;
public Boolean listArchivedSearches = null;
public Integer page = null;
public String sortOrder = null;
public String nameSearch = null;
public Boolean nameSearchExact = null;
public String filterNameExcludes = null;
public String filterReference = null;
public String filterReferenceExcludes = null;
public String filterPepType = null;
public String filterType = null;
public Date filterDateFrom = null;
public Date filterDateTo = null;
public Date filterDateRenewal = 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 isListExpiringSearches() { return listExpiringSearches; }
public GetPepSearchesRequest setListExpiringSearches(Boolean value) { this.listExpiringSearches = 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 getFilterNameExcludes() { return filterNameExcludes; }
public GetPepSearchesRequest setFilterNameExcludes(String value) { this.filterNameExcludes = value; return this; }
public String getFilterReference() { return filterReference; }
public GetPepSearchesRequest setFilterReference(String value) { this.filterReference = value; return this; }
public String getFilterReferenceExcludes() { return filterReferenceExcludes; }
public GetPepSearchesRequest setFilterReferenceExcludes(String value) { this.filterReferenceExcludes = 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 Date getFilterDateRenewal() { return filterDateRenewal; }
public GetPepSearchesRequest setFilterDateRenewal(Date value) { this.filterDateRenewal = 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<GetPepSearches xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
<UserId>String</UserId>
</Authentication>
<Request>
<FilterDateFrom>0001-01-01T00:00:00</FilterDateFrom>
<FilterDateRenewal>0001-01-01T00:00:00</FilterDateRenewal>
<FilterDateTo>0001-01-01T00:00:00</FilterDateTo>
<FilterNameExcludes>String</FilterNameExcludes>
<FilterPepType>String</FilterPepType>
<FilterReference>String</FilterReference>
<FilterReferenceExcludes>String</FilterReferenceExcludes>
<FilterType>String</FilterType>
<FilterUserName>String</FilterUserName>
<ListArchivedSearches>false</ListArchivedSearches>
<ListExpiringSearches>false</ListExpiringSearches>
<ListUnresolvedSearches>false</ListUnresolvedSearches>
<ListUpdatedSearches>false</ListUpdatedSearches>
<NameSearch>String</NameSearch>
<NameSearchExact>false</NameSearchExact>
<Page>0</Page>
<SortOrder>String</SortOrder>
<SubUserName>String</SubUserName>
</Request>
</GetPepSearches>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetPepSearchesResponse 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>
<CurrentPageNum>0</CurrentPageNum>
<MaxPageNum>0</MaxPageNum>
<SearchRecords>
<SearchRecord>
<AffectedByUpdate>false</AffectedByUpdate>
<ClientInResults>false</ClientInResults>
<ClientNotInResults>false</ClientNotInResults>
<DateArchived>0001-01-01T00:00:00</DateArchived>
<DateRenewal>0001-01-01T00:00:00</DateRenewal>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Id>0</Id>
<IsArchived>false</IsArchived>
<IsDayOneSearch>false</IsDayOneSearch>
<NumOfResults>0</NumOfResults>
<SearchCriteria>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<Name>String</Name>
<Nationality>String</Nationality>
<Reference>String</Reference>
</SearchCriteria>
<SearchType>String</SearchType>
</SearchRecord>
</SearchRecords>
<TotalSearchRecords>0</TotalSearchRecords>
</Data>
</GetPepSearchesResponse>