| POST | /validid/list | Get all the ValidID Searches |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@DataContract
public static class GetValidIds extends BaseRequest
{
@DataMember
public GetValidIdsRequest request = null;
public GetValidIdsRequest getRequest() { return request; }
public GetValidIds setRequest(GetValidIdsRequest 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 GetValidIdsRequest
{
/**
* 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 Integer page = null;
public String sortOrder = null;
public String nameSearch = null;
public String filterReference = 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 GetValidIdsRequest setSubUserName(String value) { this.subUserName = value; return this; }
public Integer getPage() { return page; }
public GetValidIdsRequest setPage(Integer value) { this.page = value; return this; }
public String getSortOrder() { return sortOrder; }
public GetValidIdsRequest setSortOrder(String value) { this.sortOrder = value; return this; }
public String getNameSearch() { return nameSearch; }
public GetValidIdsRequest setNameSearch(String value) { this.nameSearch = value; return this; }
public String getFilterReference() { return filterReference; }
public GetValidIdsRequest setFilterReference(String value) { this.filterReference = value; return this; }
public String getFilterType() { return filterType; }
public GetValidIdsRequest setFilterType(String value) { this.filterType = value; return this; }
public Date getFilterDateFrom() { return filterDateFrom; }
public GetValidIdsRequest setFilterDateFrom(Date value) { this.filterDateFrom = value; return this; }
public Date getFilterDateTo() { return filterDateTo; }
public GetValidIdsRequest setFilterDateTo(Date value) { this.filterDateTo = value; return this; }
public String getFilterUserName() { return filterUserName; }
public GetValidIdsRequest setFilterUserName(String value) { this.filterUserName = value; return this; }
}
@DataContract
public static class GetValidIdsResponse
{
@DataMember
public GetValidIdsData data = null;
public GetValidIdsData getData() { return data; }
public GetValidIdsResponse setData(GetValidIdsData value) { this.data = value; return this; }
}
public static class GetValidIdsData extends BaseResponse
{
public Integer totalSearchRecords = null;
public Integer currentPageNum = null;
public Integer maxPageNum = null;
public ArrayOfValidIdListItem searchRecords = null;
public Integer getTotalSearchRecords() { return totalSearchRecords; }
public GetValidIdsData setTotalSearchRecords(Integer value) { this.totalSearchRecords = value; return this; }
public Integer getCurrentPageNum() { return currentPageNum; }
public GetValidIdsData setCurrentPageNum(Integer value) { this.currentPageNum = value; return this; }
public Integer getMaxPageNum() { return maxPageNum; }
public GetValidIdsData setMaxPageNum(Integer value) { this.maxPageNum = value; return this; }
public ArrayOfValidIdListItem getSearchRecords() { return searchRecords; }
public GetValidIdsData setSearchRecords(ArrayOfValidIdListItem 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 ArrayOfValidIdListItem extends ArrayList<ValidIdListItem>
{
}
public static class ValidIdListItem
{
public Integer id = null;
public Integer type = null;
public Integer score = null;
public String status = null;
public Date dateSearched = null;
public String reference = null;
public Boolean pepError = null;
public Boolean replaced = null;
public Integer replacementSearchId = null;
public Boolean hasCompletedRequest = null;
public Boolean hasCompletedSearch = null;
public ValidIdSearchCriteria searchCriteria = null;
public Integer getId() { return id; }
public ValidIdListItem setId(Integer value) { this.id = value; return this; }
public Integer getType() { return type; }
public ValidIdListItem setType(Integer value) { this.type = value; return this; }
public Integer getScore() { return score; }
public ValidIdListItem setScore(Integer value) { this.score = value; return this; }
public String getStatus() { return status; }
public ValidIdListItem setStatus(String value) { this.status = value; return this; }
public Date getDateSearched() { return dateSearched; }
public ValidIdListItem setDateSearched(Date value) { this.dateSearched = value; return this; }
public String getReference() { return reference; }
public ValidIdListItem setReference(String value) { this.reference = value; return this; }
public Boolean isPepError() { return pepError; }
public ValidIdListItem setPepError(Boolean value) { this.pepError = value; return this; }
public Boolean isReplaced() { return replaced; }
public ValidIdListItem setReplaced(Boolean value) { this.replaced = value; return this; }
public Integer getReplacementSearchId() { return replacementSearchId; }
public ValidIdListItem setReplacementSearchId(Integer value) { this.replacementSearchId = value; return this; }
public Boolean isHasCompletedRequest() { return hasCompletedRequest; }
public ValidIdListItem setHasCompletedRequest(Boolean value) { this.hasCompletedRequest = value; return this; }
public Boolean isHasCompletedSearch() { return hasCompletedSearch; }
public ValidIdListItem setHasCompletedSearch(Boolean value) { this.hasCompletedSearch = value; return this; }
public ValidIdSearchCriteria getSearchCriteria() { return searchCriteria; }
public ValidIdListItem setSearchCriteria(ValidIdSearchCriteria value) { this.searchCriteria = value; return this; }
}
public static class ValidIdSearchCriteria
{
public String fullName = null;
public Date dateOfBirth = null;
public String gender = null;
public String address = null;
public String getFullName() { return fullName; }
public ValidIdSearchCriteria setFullName(String value) { this.fullName = value; return this; }
public Date getDateOfBirth() { return dateOfBirth; }
public ValidIdSearchCriteria setDateOfBirth(Date value) { this.dateOfBirth = value; return this; }
public String getGender() { return gender; }
public ValidIdSearchCriteria setGender(String value) { this.gender = value; return this; }
public String getAddress() { return address; }
public ValidIdSearchCriteria setAddress(String value) { this.address = 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 /validid/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","nameSearch":"String","filterReference":"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,"type":0,"score":0,"status":"String","dateSearched":"\/Date(-62135596800000-0000)\/","reference":"String","pepError":false,"replaced":false,"replacementSearchId":0,"hasCompletedRequest":false,"hasCompletedSearch":false,"searchCriteria":{"fullName":"String","dateOfBirth":"\/Date(-62135596800000-0000)\/","gender":"String","address":"String"}}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}