| POST | /sanctions/get | Get a sanctions search |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@DataContract
public static class GetSearch extends BaseRequest
{
@DataMember
public GetSearchRequest request = null;
public GetSearchRequest getRequest() { return request; }
public GetSearch setRequest(GetSearchRequest 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 GetSearchRequest
{
/**
* If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it
*/
@ApiMember(Description="If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it")
public String subUserName = null;
/**
* If set to true, the response will exclude resolved search results, it will only include unresolved results
*/
@ApiMember(Description="If set to true, the response will exclude resolved search results, it will only include unresolved results")
public Boolean onlyShowUnresolvedResults = null;
public Long id = null;
public String getSubUserName() { return subUserName; }
public GetSearchRequest setSubUserName(String value) { this.subUserName = value; return this; }
public Boolean isOnlyShowUnresolvedResults() { return onlyShowUnresolvedResults; }
public GetSearchRequest setOnlyShowUnresolvedResults(Boolean value) { this.onlyShowUnresolvedResults = value; return this; }
public Long getId() { return id; }
public GetSearchRequest setId(Long value) { this.id = value; return this; }
}
@DataContract
public static class GetSearchResponse
{
@DataMember
public GetSearchData data = null;
public GetSearchData getData() { return data; }
public GetSearchResponse setData(GetSearchData value) { this.data = value; return this; }
}
public static class GetSearchData extends BaseResponse implements IBaseSearchResponse
{
public ArrayOfLinkedTo linkedTo = null;
public SearchRecord searchRecord = null;
public ArrayOfLinkedTo getLinkedTo() { return linkedTo; }
public GetSearchData setLinkedTo(ArrayOfLinkedTo value) { this.linkedTo = value; return this; }
public SearchRecord getSearchRecord() { return searchRecord; }
public GetSearchData setSearchRecord(SearchRecord value) { this.searchRecord = 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 ArrayOfLinkedTo extends ArrayList<LinkedTo>
{
}
public static class LinkedTo
{
public Integer clientId = null;
public Long id = null;
public String type = null;
public String subtype = null;
public String status = null;
public String description = null;
public Boolean isArchived = null;
public String name = null;
public Date date = null;
public Integer getClientId() { return clientId; }
public LinkedTo setClientId(Integer value) { this.clientId = value; return this; }
public Long getId() { return id; }
public LinkedTo setId(Long value) { this.id = value; return this; }
public String getType() { return type; }
public LinkedTo setType(String value) { this.type = value; return this; }
public String getSubtype() { return subtype; }
public LinkedTo setSubtype(String value) { this.subtype = value; return this; }
public String getStatus() { return status; }
public LinkedTo setStatus(String value) { this.status = value; return this; }
public String getDescription() { return description; }
public LinkedTo setDescription(String value) { this.description = value; return this; }
public Boolean getIsArchived() { return isArchived; }
public LinkedTo setIsArchived(Boolean value) { this.isArchived = value; return this; }
public String getName() { return name; }
public LinkedTo setName(String value) { this.name = value; return this; }
public Date getDate() { return date; }
public LinkedTo setDate(Date value) { this.date = value; return this; }
}
public static class SearchRecord
{
public Long id = null;
public String searchType = null;
public Date dateSearched = null;
public Date dateUpdated = 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 SearchCriteria searchCriteria = null;
public SearchResults searchResults = null;
public ArrayList<SearchSource> searchSources = null;
public ArrayOfSearchResultEntries listSearchResults = null;
public Long getId() { return id; }
public SearchRecord setId(Long value) { this.id = value; return this; }
public String getSearchType() { return searchType; }
public SearchRecord setSearchType(String value) { this.searchType = value; return this; }
public Date getDateSearched() { return dateSearched; }
public SearchRecord setDateSearched(Date value) { this.dateSearched = value; return this; }
public Date getDateUpdated() { return dateUpdated; }
public SearchRecord setDateUpdated(Date value) { this.dateUpdated = value; return this; }
public Date getDateArchived() { return dateArchived; }
public SearchRecord setDateArchived(Date value) { this.dateArchived = value; return this; }
public Boolean getIsArchived() { return isArchived; }
public SearchRecord setIsArchived(Boolean value) { this.isArchived = value; return this; }
public Integer getNumOfResults() { return numOfResults; }
public SearchRecord setNumOfResults(Integer value) { this.numOfResults = value; return this; }
public Boolean isClientInResults() { return clientInResults; }
public SearchRecord setClientInResults(Boolean value) { this.clientInResults = value; return this; }
public Boolean isClientNotInResults() { return clientNotInResults; }
public SearchRecord setClientNotInResults(Boolean value) { this.clientNotInResults = value; return this; }
public Boolean isAffectedByUpdate() { return affectedByUpdate; }
public SearchRecord setAffectedByUpdate(Boolean value) { this.affectedByUpdate = value; return this; }
public SearchCriteria getSearchCriteria() { return searchCriteria; }
public SearchRecord setSearchCriteria(SearchCriteria value) { this.searchCriteria = value; return this; }
public SearchResults getSearchResults() { return searchResults; }
public SearchRecord setSearchResults(SearchResults value) { this.searchResults = value; return this; }
public ArrayList<SearchSource> getSearchSources() { return searchSources; }
public SearchRecord setSearchSources(ArrayList<SearchSource> value) { this.searchSources = value; return this; }
public ArrayOfSearchResultEntries getListSearchResults() { return listSearchResults; }
public SearchRecord setListSearchResults(ArrayOfSearchResultEntries value) { this.listSearchResults = 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; }
}
public static class SearchResults
{
public ArrayList<SearchResultEu> euResults = null;
public ArrayList<SearchResultHmTreasury> hmtResults = null;
public ArrayList<SearchResultHmTreasury> hmtUkraineResults = null;
public ArrayList<SearchResultOfac> ofacResults = null;
public ArrayList<SearchResultOfac> ofacConsolidatedResults = null;
public ArrayList<SearchResultDfat> dfatResults = null;
public ArrayList<SearchResultOsfi> osfiResults = null;
public ArrayList<SearchResultCanadianJustice> canadianJusticeResults = null;
public ArrayList<SearchResultCanadianSema> canadianSemaResults = null;
public ArrayList<SearchResultEntry> swissSecoResults = null;
public ArrayList<SearchResultEu> getEuResults() { return euResults; }
public SearchResults setEuResults(ArrayList<SearchResultEu> value) { this.euResults = value; return this; }
public ArrayList<SearchResultHmTreasury> getHmtResults() { return hmtResults; }
public SearchResults setHmtResults(ArrayList<SearchResultHmTreasury> value) { this.hmtResults = value; return this; }
public ArrayList<SearchResultHmTreasury> getHmtUkraineResults() { return hmtUkraineResults; }
public SearchResults setHmtUkraineResults(ArrayList<SearchResultHmTreasury> value) { this.hmtUkraineResults = value; return this; }
public ArrayList<SearchResultOfac> getOfacResults() { return ofacResults; }
public SearchResults setOfacResults(ArrayList<SearchResultOfac> value) { this.ofacResults = value; return this; }
public ArrayList<SearchResultOfac> getOfacConsolidatedResults() { return ofacConsolidatedResults; }
public SearchResults setOfacConsolidatedResults(ArrayList<SearchResultOfac> value) { this.ofacConsolidatedResults = value; return this; }
public ArrayList<SearchResultDfat> getDfatResults() { return dfatResults; }
public SearchResults setDfatResults(ArrayList<SearchResultDfat> value) { this.dfatResults = value; return this; }
public ArrayList<SearchResultOsfi> getOsfiResults() { return osfiResults; }
public SearchResults setOsfiResults(ArrayList<SearchResultOsfi> value) { this.osfiResults = value; return this; }
public ArrayList<SearchResultCanadianJustice> getCanadianJusticeResults() { return canadianJusticeResults; }
public SearchResults setCanadianJusticeResults(ArrayList<SearchResultCanadianJustice> value) { this.canadianJusticeResults = value; return this; }
public ArrayList<SearchResultCanadianSema> getCanadianSemaResults() { return canadianSemaResults; }
public SearchResults setCanadianSemaResults(ArrayList<SearchResultCanadianSema> value) { this.canadianSemaResults = value; return this; }
public ArrayList<SearchResultEntry> getSwissSecoResults() { return swissSecoResults; }
public SearchResults setSwissSecoResults(ArrayList<SearchResultEntry> value) { this.swissSecoResults = value; return this; }
}
public static class SearchResultEu
{
public Integer resultStrength = null;
public BigDecimal resultSimilarity = null;
public Boolean resultResolved = null;
public String resultType = null;
public Date dateUpdated = null;
public ArrayList<SearchResultEuAddress> addresses = null;
public ArrayList<SearchResultEuBirth> births = null;
public ArrayList<SearchResultOfacEuCitizenship> citizenships = null;
public ArrayList<SearchResultEuName> names = null;
public ArrayList<SearchResultEuPassport> passports = null;
public Integer getResultStrength() { return resultStrength; }
public SearchResultEu setResultStrength(Integer value) { this.resultStrength = value; return this; }
public BigDecimal getResultSimilarity() { return resultSimilarity; }
public SearchResultEu setResultSimilarity(BigDecimal value) { this.resultSimilarity = value; return this; }
public Boolean isResultResolved() { return resultResolved; }
public SearchResultEu setResultResolved(Boolean value) { this.resultResolved = value; return this; }
public String getResultType() { return resultType; }
public SearchResultEu setResultType(String value) { this.resultType = value; return this; }
public Date getDateUpdated() { return dateUpdated; }
public SearchResultEu setDateUpdated(Date value) { this.dateUpdated = value; return this; }
public ArrayList<SearchResultEuAddress> getAddresses() { return addresses; }
public SearchResultEu setAddresses(ArrayList<SearchResultEuAddress> value) { this.addresses = value; return this; }
public ArrayList<SearchResultEuBirth> getBirths() { return births; }
public SearchResultEu setBirths(ArrayList<SearchResultEuBirth> value) { this.births = value; return this; }
public ArrayList<SearchResultOfacEuCitizenship> getCitizenships() { return citizenships; }
public SearchResultEu setCitizenships(ArrayList<SearchResultOfacEuCitizenship> value) { this.citizenships = value; return this; }
public ArrayList<SearchResultEuName> getNames() { return names; }
public SearchResultEu setNames(ArrayList<SearchResultEuName> value) { this.names = value; return this; }
public ArrayList<SearchResultEuPassport> getPassports() { return passports; }
public SearchResultEu setPassports(ArrayList<SearchResultEuPassport> value) { this.passports = value; return this; }
}
public static class SearchResultEuAddress
{
public String street = null;
public String city = null;
public String country = null;
public String postCode = null;
public String other = null;
public String getStreet() { return street; }
public SearchResultEuAddress setStreet(String value) { this.street = value; return this; }
public String getCity() { return city; }
public SearchResultEuAddress setCity(String value) { this.city = value; return this; }
public String getCountry() { return country; }
public SearchResultEuAddress setCountry(String value) { this.country = value; return this; }
public String getPostCode() { return postCode; }
public SearchResultEuAddress setPostCode(String value) { this.postCode = value; return this; }
public String getOther() { return other; }
public SearchResultEuAddress setOther(String value) { this.other = value; return this; }
}
public static class SearchResultEuBirth
{
public String date = null;
public String place = null;
public String country = null;
public String getDate() { return date; }
public SearchResultEuBirth setDate(String value) { this.date = value; return this; }
public String getPlace() { return place; }
public SearchResultEuBirth setPlace(String value) { this.place = value; return this; }
public String getCountry() { return country; }
public SearchResultEuBirth setCountry(String value) { this.country = value; return this; }
}
public static class SearchResultOfacEuCitizenship
{
public String country = null;
public String getCountry() { return country; }
public SearchResultOfacEuCitizenship setCountry(String value) { this.country = value; return this; }
}
public static class SearchResultEuName
{
public String fullName = null;
public String gender = null;
public String getFullName() { return fullName; }
public SearchResultEuName setFullName(String value) { this.fullName = value; return this; }
public String getGender() { return gender; }
public SearchResultEuName setGender(String value) { this.gender = value; return this; }
}
public static class SearchResultEuPassport
{
public String number = null;
public String country = null;
public String getNumber() { return number; }
public SearchResultEuPassport setNumber(String value) { this.number = value; return this; }
public String getCountry() { return country; }
public SearchResultEuPassport setCountry(String value) { this.country = value; return this; }
}
public static class SearchResultHmTreasury
{
public Integer resultStrength = null;
public BigDecimal resultSimilarity = null;
public Boolean resultResolved = null;
public String resultType = null;
public Date dateListed = null;
public Date dateUpdated = null;
public String name1 = null;
public String name2 = null;
public String name3 = null;
public String name4 = null;
public String name5 = null;
public String name6 = null;
public String dateOfBirth = null;
public String countryOfBirth = null;
public String nationality = null;
public String address1 = null;
public String address2 = null;
public String address3 = null;
public String address4 = null;
public String address5 = null;
public String address6 = null;
public String postCode = null;
public String country = null;
public Integer getResultStrength() { return resultStrength; }
public SearchResultHmTreasury setResultStrength(Integer value) { this.resultStrength = value; return this; }
public BigDecimal getResultSimilarity() { return resultSimilarity; }
public SearchResultHmTreasury setResultSimilarity(BigDecimal value) { this.resultSimilarity = value; return this; }
public Boolean isResultResolved() { return resultResolved; }
public SearchResultHmTreasury setResultResolved(Boolean value) { this.resultResolved = value; return this; }
public String getResultType() { return resultType; }
public SearchResultHmTreasury setResultType(String value) { this.resultType = value; return this; }
public Date getDateListed() { return dateListed; }
public SearchResultHmTreasury setDateListed(Date value) { this.dateListed = value; return this; }
public Date getDateUpdated() { return dateUpdated; }
public SearchResultHmTreasury setDateUpdated(Date value) { this.dateUpdated = value; return this; }
public String getName1() { return name1; }
public SearchResultHmTreasury setName1(String value) { this.name1 = value; return this; }
public String getName2() { return name2; }
public SearchResultHmTreasury setName2(String value) { this.name2 = value; return this; }
public String getName3() { return name3; }
public SearchResultHmTreasury setName3(String value) { this.name3 = value; return this; }
public String getName4() { return name4; }
public SearchResultHmTreasury setName4(String value) { this.name4 = value; return this; }
public String getName5() { return name5; }
public SearchResultHmTreasury setName5(String value) { this.name5 = value; return this; }
public String getName6() { return name6; }
public SearchResultHmTreasury setName6(String value) { this.name6 = value; return this; }
public String getDateOfBirth() { return dateOfBirth; }
public SearchResultHmTreasury setDateOfBirth(String value) { this.dateOfBirth = value; return this; }
public String getCountryOfBirth() { return countryOfBirth; }
public SearchResultHmTreasury setCountryOfBirth(String value) { this.countryOfBirth = value; return this; }
public String getNationality() { return nationality; }
public SearchResultHmTreasury setNationality(String value) { this.nationality = value; return this; }
public String getAddress1() { return address1; }
public SearchResultHmTreasury setAddress1(String value) { this.address1 = value; return this; }
public String getAddress2() { return address2; }
public SearchResultHmTreasury setAddress2(String value) { this.address2 = value; return this; }
public String getAddress3() { return address3; }
public SearchResultHmTreasury setAddress3(String value) { this.address3 = value; return this; }
public String getAddress4() { return address4; }
public SearchResultHmTreasury setAddress4(String value) { this.address4 = value; return this; }
public String getAddress5() { return address5; }
public SearchResultHmTreasury setAddress5(String value) { this.address5 = value; return this; }
public String getAddress6() { return address6; }
public SearchResultHmTreasury setAddress6(String value) { this.address6 = value; return this; }
public String getPostCode() { return postCode; }
public SearchResultHmTreasury setPostCode(String value) { this.postCode = value; return this; }
public String getCountry() { return country; }
public SearchResultHmTreasury setCountry(String value) { this.country = value; return this; }
}
public static class SearchResultOfac
{
public Integer resultStrength = null;
public BigDecimal resultSimilarity = null;
public Boolean resultResolved = null;
public String resultType = null;
public Date dateUpdated = null;
public String firstName = null;
public String lastName = null;
public ArrayList<SearchResultOfacAddress> addresses = null;
public ArrayList<SearchResultOfacAka> akas = null;
public ArrayList<SearchResultOfacDateOfBirth> dateOfBirths = null;
public ArrayList<SearchResultOfacNationality> nationalities = null;
public ArrayList<SearchResultOfacPlaceOfBirth> placeOfBirths = null;
public Integer getResultStrength() { return resultStrength; }
public SearchResultOfac setResultStrength(Integer value) { this.resultStrength = value; return this; }
public BigDecimal getResultSimilarity() { return resultSimilarity; }
public SearchResultOfac setResultSimilarity(BigDecimal value) { this.resultSimilarity = value; return this; }
public Boolean isResultResolved() { return resultResolved; }
public SearchResultOfac setResultResolved(Boolean value) { this.resultResolved = value; return this; }
public String getResultType() { return resultType; }
public SearchResultOfac setResultType(String value) { this.resultType = value; return this; }
public Date getDateUpdated() { return dateUpdated; }
public SearchResultOfac setDateUpdated(Date value) { this.dateUpdated = value; return this; }
public String getFirstName() { return firstName; }
public SearchResultOfac setFirstName(String value) { this.firstName = value; return this; }
public String getLastName() { return lastName; }
public SearchResultOfac setLastName(String value) { this.lastName = value; return this; }
public ArrayList<SearchResultOfacAddress> getAddresses() { return addresses; }
public SearchResultOfac setAddresses(ArrayList<SearchResultOfacAddress> value) { this.addresses = value; return this; }
public ArrayList<SearchResultOfacAka> getAkas() { return akas; }
public SearchResultOfac setAkas(ArrayList<SearchResultOfacAka> value) { this.akas = value; return this; }
public ArrayList<SearchResultOfacDateOfBirth> getDateOfBirths() { return dateOfBirths; }
public SearchResultOfac setDateOfBirths(ArrayList<SearchResultOfacDateOfBirth> value) { this.dateOfBirths = value; return this; }
public ArrayList<SearchResultOfacNationality> getNationalities() { return nationalities; }
public SearchResultOfac setNationalities(ArrayList<SearchResultOfacNationality> value) { this.nationalities = value; return this; }
public ArrayList<SearchResultOfacPlaceOfBirth> getPlaceOfBirths() { return placeOfBirths; }
public SearchResultOfac setPlaceOfBirths(ArrayList<SearchResultOfacPlaceOfBirth> value) { this.placeOfBirths = value; return this; }
}
public static class SearchResultOfacAddress
{
public String address1 = null;
public String address2 = null;
public String address3 = null;
public String city = null;
public String state = null;
public String postCode = null;
public String country = null;
public String getAddress1() { return address1; }
public SearchResultOfacAddress setAddress1(String value) { this.address1 = value; return this; }
public String getAddress2() { return address2; }
public SearchResultOfacAddress setAddress2(String value) { this.address2 = value; return this; }
public String getAddress3() { return address3; }
public SearchResultOfacAddress setAddress3(String value) { this.address3 = value; return this; }
public String getCity() { return city; }
public SearchResultOfacAddress setCity(String value) { this.city = value; return this; }
public String getState() { return state; }
public SearchResultOfacAddress setState(String value) { this.state = value; return this; }
public String getPostCode() { return postCode; }
public SearchResultOfacAddress setPostCode(String value) { this.postCode = value; return this; }
public String getCountry() { return country; }
public SearchResultOfacAddress setCountry(String value) { this.country = value; return this; }
}
public static class SearchResultOfacAka
{
public String firstName = null;
public String lastName = null;
public String type = null;
public String strength = null;
public String getFirstName() { return firstName; }
public SearchResultOfacAka setFirstName(String value) { this.firstName = value; return this; }
public String getLastName() { return lastName; }
public SearchResultOfacAka setLastName(String value) { this.lastName = value; return this; }
public String getType() { return type; }
public SearchResultOfacAka setType(String value) { this.type = value; return this; }
public String getStrength() { return strength; }
public SearchResultOfacAka setStrength(String value) { this.strength = value; return this; }
}
public static class SearchResultOfacDateOfBirth
{
public String dateOfBirth = null;
public String getDateOfBirth() { return dateOfBirth; }
public SearchResultOfacDateOfBirth setDateOfBirth(String value) { this.dateOfBirth = value; return this; }
}
public static class SearchResultOfacNationality
{
public String country = null;
public String getCountry() { return country; }
public SearchResultOfacNationality setCountry(String value) { this.country = value; return this; }
}
public static class SearchResultOfacPlaceOfBirth
{
public String placeOfBirth = null;
public String getPlaceOfBirth() { return placeOfBirth; }
public SearchResultOfacPlaceOfBirth setPlaceOfBirth(String value) { this.placeOfBirth = value; return this; }
}
public static class SearchResultDfat
{
public Integer resultStrength = null;
public BigDecimal resultSimilarity = null;
public Boolean resultResolved = null;
public String resultType = null;
public Date dateUpdated = null;
public String fullName = null;
public String address = null;
public String dateOfBirth = null;
public String placeOfBirth = null;
public String nationality = null;
public Integer getResultStrength() { return resultStrength; }
public SearchResultDfat setResultStrength(Integer value) { this.resultStrength = value; return this; }
public BigDecimal getResultSimilarity() { return resultSimilarity; }
public SearchResultDfat setResultSimilarity(BigDecimal value) { this.resultSimilarity = value; return this; }
public Boolean isResultResolved() { return resultResolved; }
public SearchResultDfat setResultResolved(Boolean value) { this.resultResolved = value; return this; }
public String getResultType() { return resultType; }
public SearchResultDfat setResultType(String value) { this.resultType = value; return this; }
public Date getDateUpdated() { return dateUpdated; }
public SearchResultDfat setDateUpdated(Date value) { this.dateUpdated = value; return this; }
public String getFullName() { return fullName; }
public SearchResultDfat setFullName(String value) { this.fullName = value; return this; }
public String getAddress() { return address; }
public SearchResultDfat setAddress(String value) { this.address = value; return this; }
public String getDateOfBirth() { return dateOfBirth; }
public SearchResultDfat setDateOfBirth(String value) { this.dateOfBirth = value; return this; }
public String getPlaceOfBirth() { return placeOfBirth; }
public SearchResultDfat setPlaceOfBirth(String value) { this.placeOfBirth = value; return this; }
public String getNationality() { return nationality; }
public SearchResultDfat setNationality(String value) { this.nationality = value; return this; }
}
public static class SearchResultOsfi
{
public Integer resultStrength = null;
public BigDecimal resultSimilarity = null;
public Boolean resultResolved = null;
public String resultType = null;
public Date dateUpdated = null;
public String fullName = null;
public String address = null;
public String dateOfBirth = null;
public String placeOfBirth = null;
public String nationality = null;
public Integer getResultStrength() { return resultStrength; }
public SearchResultOsfi setResultStrength(Integer value) { this.resultStrength = value; return this; }
public BigDecimal getResultSimilarity() { return resultSimilarity; }
public SearchResultOsfi setResultSimilarity(BigDecimal value) { this.resultSimilarity = value; return this; }
public Boolean isResultResolved() { return resultResolved; }
public SearchResultOsfi setResultResolved(Boolean value) { this.resultResolved = value; return this; }
public String getResultType() { return resultType; }
public SearchResultOsfi setResultType(String value) { this.resultType = value; return this; }
public Date getDateUpdated() { return dateUpdated; }
public SearchResultOsfi setDateUpdated(Date value) { this.dateUpdated = value; return this; }
public String getFullName() { return fullName; }
public SearchResultOsfi setFullName(String value) { this.fullName = value; return this; }
public String getAddress() { return address; }
public SearchResultOsfi setAddress(String value) { this.address = value; return this; }
public String getDateOfBirth() { return dateOfBirth; }
public SearchResultOsfi setDateOfBirth(String value) { this.dateOfBirth = value; return this; }
public String getPlaceOfBirth() { return placeOfBirth; }
public SearchResultOsfi setPlaceOfBirth(String value) { this.placeOfBirth = value; return this; }
public String getNationality() { return nationality; }
public SearchResultOsfi setNationality(String value) { this.nationality = value; return this; }
}
public static class SearchResultCanadianJustice
{
public Integer resultStrength = null;
public BigDecimal resultSimilarity = null;
public Boolean resultResolved = null;
public String resultType = null;
public Date dateUpdated = null;
public String name = null;
public String dateOfBirth = null;
public String country = null;
public Integer refId = null;
public Integer getResultStrength() { return resultStrength; }
public SearchResultCanadianJustice setResultStrength(Integer value) { this.resultStrength = value; return this; }
public BigDecimal getResultSimilarity() { return resultSimilarity; }
public SearchResultCanadianJustice setResultSimilarity(BigDecimal value) { this.resultSimilarity = value; return this; }
public Boolean isResultResolved() { return resultResolved; }
public SearchResultCanadianJustice setResultResolved(Boolean value) { this.resultResolved = value; return this; }
public String getResultType() { return resultType; }
public SearchResultCanadianJustice setResultType(String value) { this.resultType = value; return this; }
public Date getDateUpdated() { return dateUpdated; }
public SearchResultCanadianJustice setDateUpdated(Date value) { this.dateUpdated = value; return this; }
public String getName() { return name; }
public SearchResultCanadianJustice setName(String value) { this.name = value; return this; }
public String getDateOfBirth() { return dateOfBirth; }
public SearchResultCanadianJustice setDateOfBirth(String value) { this.dateOfBirth = value; return this; }
public String getCountry() { return country; }
public SearchResultCanadianJustice setCountry(String value) { this.country = value; return this; }
public Integer getRefId() { return refId; }
public SearchResultCanadianJustice setRefId(Integer value) { this.refId = value; return this; }
}
public static class SearchResultCanadianSema
{
public Integer resultStrength = null;
public BigDecimal resultSimilarity = null;
public Boolean resultResolved = null;
public String resultType = null;
public Date dateUpdated = null;
public String name = null;
public String dateOfBirth = null;
public String country = null;
public String schedule = null;
public String item = null;
public Integer getResultStrength() { return resultStrength; }
public SearchResultCanadianSema setResultStrength(Integer value) { this.resultStrength = value; return this; }
public BigDecimal getResultSimilarity() { return resultSimilarity; }
public SearchResultCanadianSema setResultSimilarity(BigDecimal value) { this.resultSimilarity = value; return this; }
public Boolean isResultResolved() { return resultResolved; }
public SearchResultCanadianSema setResultResolved(Boolean value) { this.resultResolved = value; return this; }
public String getResultType() { return resultType; }
public SearchResultCanadianSema setResultType(String value) { this.resultType = value; return this; }
public Date getDateUpdated() { return dateUpdated; }
public SearchResultCanadianSema setDateUpdated(Date value) { this.dateUpdated = value; return this; }
public String getName() { return name; }
public SearchResultCanadianSema setName(String value) { this.name = value; return this; }
public String getDateOfBirth() { return dateOfBirth; }
public SearchResultCanadianSema setDateOfBirth(String value) { this.dateOfBirth = value; return this; }
public String getCountry() { return country; }
public SearchResultCanadianSema setCountry(String value) { this.country = value; return this; }
public String getSchedule() { return schedule; }
public SearchResultCanadianSema setSchedule(String value) { this.schedule = value; return this; }
public String getItem() { return item; }
public SearchResultCanadianSema setItem(String value) { this.item = value; return this; }
}
public static class SearchResultEntry
{
public Long searchResultId = null;
public Integer resultStrength = null;
public BigDecimal resultSimilarity = null;
public Boolean resultResolved = null;
public String resultType = null;
public Date dateUpdated = null;
public String sanctionsListId = null;
public String sanctionsListName = null;
public ArrayList<SearchResultAddress> addresses = null;
public ArrayList<SearchResultDateOfBirth> datesOfBirth = null;
public ArrayList<SearchResultName> names = null;
public ArrayList<SearchResultNationality> nationalities = null;
public ArrayList<SearchResultPlaceOfBirth> placesOfBirth = null;
public ArrayList<SearchResultRemark> remarks = null;
public Long getSearchResultId() { return searchResultId; }
public SearchResultEntry setSearchResultId(Long value) { this.searchResultId = value; return this; }
public Integer getResultStrength() { return resultStrength; }
public SearchResultEntry setResultStrength(Integer value) { this.resultStrength = value; return this; }
public BigDecimal getResultSimilarity() { return resultSimilarity; }
public SearchResultEntry setResultSimilarity(BigDecimal value) { this.resultSimilarity = value; return this; }
public Boolean isResultResolved() { return resultResolved; }
public SearchResultEntry setResultResolved(Boolean value) { this.resultResolved = value; return this; }
public String getResultType() { return resultType; }
public SearchResultEntry setResultType(String value) { this.resultType = value; return this; }
public Date getDateUpdated() { return dateUpdated; }
public SearchResultEntry setDateUpdated(Date value) { this.dateUpdated = value; return this; }
public String getSanctionsListId() { return sanctionsListId; }
public SearchResultEntry setSanctionsListId(String value) { this.sanctionsListId = value; return this; }
public String getSanctionsListName() { return sanctionsListName; }
public SearchResultEntry setSanctionsListName(String value) { this.sanctionsListName = value; return this; }
public ArrayList<SearchResultAddress> getAddresses() { return addresses; }
public SearchResultEntry setAddresses(ArrayList<SearchResultAddress> value) { this.addresses = value; return this; }
public ArrayList<SearchResultDateOfBirth> getDatesOfBirth() { return datesOfBirth; }
public SearchResultEntry setDatesOfBirth(ArrayList<SearchResultDateOfBirth> value) { this.datesOfBirth = value; return this; }
public ArrayList<SearchResultName> getNames() { return names; }
public SearchResultEntry setNames(ArrayList<SearchResultName> value) { this.names = value; return this; }
public ArrayList<SearchResultNationality> getNationalities() { return nationalities; }
public SearchResultEntry setNationalities(ArrayList<SearchResultNationality> value) { this.nationalities = value; return this; }
public ArrayList<SearchResultPlaceOfBirth> getPlacesOfBirth() { return placesOfBirth; }
public SearchResultEntry setPlacesOfBirth(ArrayList<SearchResultPlaceOfBirth> value) { this.placesOfBirth = value; return this; }
public ArrayList<SearchResultRemark> getRemarks() { return remarks; }
public SearchResultEntry setRemarks(ArrayList<SearchResultRemark> value) { this.remarks = value; return this; }
}
public static class SearchResultAddress
{
public Long searchResultAddressId = null;
public String type = null;
public String address1 = null;
public String address2 = null;
public String address3 = null;
public String city = null;
public String county = null;
public String postCode = null;
public String country = null;
public Long getSearchResultAddressId() { return searchResultAddressId; }
public SearchResultAddress setSearchResultAddressId(Long value) { this.searchResultAddressId = value; return this; }
public String getType() { return type; }
public SearchResultAddress setType(String value) { this.type = value; return this; }
public String getAddress1() { return address1; }
public SearchResultAddress setAddress1(String value) { this.address1 = value; return this; }
public String getAddress2() { return address2; }
public SearchResultAddress setAddress2(String value) { this.address2 = value; return this; }
public String getAddress3() { return address3; }
public SearchResultAddress setAddress3(String value) { this.address3 = value; return this; }
public String getCity() { return city; }
public SearchResultAddress setCity(String value) { this.city = value; return this; }
public String getCounty() { return county; }
public SearchResultAddress setCounty(String value) { this.county = value; return this; }
public String getPostCode() { return postCode; }
public SearchResultAddress setPostCode(String value) { this.postCode = value; return this; }
public String getCountry() { return country; }
public SearchResultAddress setCountry(String value) { this.country = value; return this; }
}
public static class SearchResultDateOfBirth
{
public Long searchResultDateOfBirthId = null;
public String dateOfBirth = null;
public Short year = null;
public Short month = null;
public Short day = null;
public String type = null;
public Long getSearchResultDateOfBirthId() { return searchResultDateOfBirthId; }
public SearchResultDateOfBirth setSearchResultDateOfBirthId(Long value) { this.searchResultDateOfBirthId = value; return this; }
public String getDateOfBirth() { return dateOfBirth; }
public SearchResultDateOfBirth setDateOfBirth(String value) { this.dateOfBirth = value; return this; }
public Short getYear() { return year; }
public SearchResultDateOfBirth setYear(Short value) { this.year = value; return this; }
public Short getMonth() { return month; }
public SearchResultDateOfBirth setMonth(Short value) { this.month = value; return this; }
public Short getDay() { return day; }
public SearchResultDateOfBirth setDay(Short value) { this.day = value; return this; }
public String getType() { return type; }
public SearchResultDateOfBirth setType(String value) { this.type = value; return this; }
}
public static class SearchResultName
{
public Long searchResultNameId = null;
public String type = null;
public String title = null;
public String fullName = null;
public BigDecimal resultSimilarity = null;
public Long getSearchResultNameId() { return searchResultNameId; }
public SearchResultName setSearchResultNameId(Long value) { this.searchResultNameId = value; return this; }
public String getType() { return type; }
public SearchResultName setType(String value) { this.type = value; return this; }
public String getTitle() { return title; }
public SearchResultName setTitle(String value) { this.title = value; return this; }
public String getFullName() { return fullName; }
public SearchResultName setFullName(String value) { this.fullName = value; return this; }
public BigDecimal getResultSimilarity() { return resultSimilarity; }
public SearchResultName setResultSimilarity(BigDecimal value) { this.resultSimilarity = value; return this; }
}
public static class SearchResultNationality
{
public Long searchResultNationalityId = null;
public String nationality = null;
public Long getSearchResultNationalityId() { return searchResultNationalityId; }
public SearchResultNationality setSearchResultNationalityId(Long value) { this.searchResultNationalityId = value; return this; }
public String getNationality() { return nationality; }
public SearchResultNationality setNationality(String value) { this.nationality = value; return this; }
}
public static class SearchResultPlaceOfBirth
{
public Long searchResultPlaceOfBirthId = null;
public String placeOfBirth = null;
public String countryOfBirth = null;
public Long getSearchResultPlaceOfBirthId() { return searchResultPlaceOfBirthId; }
public SearchResultPlaceOfBirth setSearchResultPlaceOfBirthId(Long value) { this.searchResultPlaceOfBirthId = value; return this; }
public String getPlaceOfBirth() { return placeOfBirth; }
public SearchResultPlaceOfBirth setPlaceOfBirth(String value) { this.placeOfBirth = value; return this; }
public String getCountryOfBirth() { return countryOfBirth; }
public SearchResultPlaceOfBirth setCountryOfBirth(String value) { this.countryOfBirth = value; return this; }
}
public static class SearchResultRemark
{
public Long searchResultRemarkId = null;
public String name = null;
public String description = null;
public Long getSearchResultRemarkId() { return searchResultRemarkId; }
public SearchResultRemark setSearchResultRemarkId(Long value) { this.searchResultRemarkId = value; return this; }
public String getName() { return name; }
public SearchResultRemark setName(String value) { this.name = value; return this; }
public String getDescription() { return description; }
public SearchResultRemark setDescription(String value) { this.description = value; return this; }
}
public static class SearchSource
{
public String listId = null;
public String listName = null;
public String listShortName = null;
public Boolean isAffectedByListUpdate = null;
public String getListId() { return listId; }
public SearchSource setListId(String value) { this.listId = value; return this; }
public String getListName() { return listName; }
public SearchSource setListName(String value) { this.listName = value; return this; }
public String getListShortName() { return listShortName; }
public SearchSource setListShortName(String value) { this.listShortName = value; return this; }
public Boolean getIsAffectedByListUpdate() { return isAffectedByListUpdate; }
public SearchSource setIsAffectedByListUpdate(Boolean value) { this.isAffectedByListUpdate = value; return this; }
}
public static class ArrayOfSearchResultEntries extends ArrayList<SearchResultEntry>
{
}
}
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 /sanctions/get HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","onlyShowUnresolvedResults":false,"id":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"searchRecord":{"id":0,"searchType":"String","dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","dateArchived":"\/Date(-62135596800000-0000)\/","isArchived":false,"numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"searchResults":{"euResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","addresses":[{"street":"String","city":"String","country":"String","postCode":"String","other":"String"}],"births":[{"date":"String","place":"String","country":"String"}],"citizenships":[{"country":"String"}],"names":[{"fullName":"String","gender":"String"}],"passports":[{"number":"String","country":"String"}]}],"hmtResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateListed":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","name1":"String","name2":"String","name3":"String","name4":"String","name5":"String","name6":"String","dateOfBirth":"String","countryOfBirth":"String","nationality":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","address6":"String","postCode":"String","country":"String"}],"hmtUkraineResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateListed":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","name1":"String","name2":"String","name3":"String","name4":"String","name5":"String","name6":"String","dateOfBirth":"String","countryOfBirth":"String","nationality":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","address6":"String","postCode":"String","country":"String"}],"ofacResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","firstName":"String","lastName":"String","addresses":[{"address1":"String","address2":"String","address3":"String","city":"String","state":"String","postCode":"String","country":"String"}],"akas":[{"firstName":"String","lastName":"String","type":"String","strength":"String"}],"dateOfBirths":[{"dateOfBirth":"String"}],"nationalities":[{"country":"String"}],"placeOfBirths":[{"placeOfBirth":"String"}]}],"ofacConsolidatedResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","firstName":"String","lastName":"String","addresses":[{"address1":"String","address2":"String","address3":"String","city":"String","state":"String","postCode":"String","country":"String"}],"akas":[{"firstName":"String","lastName":"String","type":"String","strength":"String"}],"dateOfBirths":[{"dateOfBirth":"String"}],"nationalities":[{"country":"String"}],"placeOfBirths":[{"placeOfBirth":"String"}]}],"dfatResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String","address":"String","dateOfBirth":"String","placeOfBirth":"String","nationality":"String"}],"osfiResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String","address":"String","dateOfBirth":"String","placeOfBirth":"String","nationality":"String"}],"canadianJusticeResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","name":"String","dateOfBirth":"String","country":"String","refId":0}],"canadianSemaResults":[{"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","name":"String","dateOfBirth":"String","country":"String","schedule":"String","item":"String"}],"swissSecoResults":[{"searchResultId":0,"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","sanctionsListId":"String","sanctionsListName":"String","addresses":[{"searchResultAddressId":0,"type":"String","address1":"String","address2":"String","address3":"String","city":"String","county":"String","postCode":"String","country":"String"}],"datesOfBirth":[{"searchResultDateOfBirthId":0,"dateOfBirth":"String","year":0,"month":0,"day":0,"type":"String"}],"names":[{"searchResultNameId":0,"type":"String","title":"String","fullName":"String","resultSimilarity":0}],"nationalities":[{"searchResultNationalityId":0,"nationality":"String"}],"placesOfBirth":[{"searchResultPlaceOfBirthId":0,"placeOfBirth":"String","countryOfBirth":"String"}],"remarks":[{"searchResultRemarkId":0,"name":"String","description":"String"}]}]},"searchSources":[{"listId":"String","listName":"String","listShortName":"String","isAffectedByListUpdate":false}],"listSearchResults":[{"searchResultId":0,"resultStrength":0,"resultSimilarity":0,"resultResolved":false,"resultType":"String","dateUpdated":"\/Date(-62135596800000-0000)\/","sanctionsListId":"String","sanctionsListName":"String","addresses":[{"searchResultAddressId":0,"type":"String","address1":"String","address2":"String","address3":"String","city":"String","county":"String","postCode":"String","country":"String"}],"datesOfBirth":[{"searchResultDateOfBirthId":0,"dateOfBirth":"String","year":0,"month":0,"day":0,"type":"String"}],"names":[{"searchResultNameId":0,"type":"String","title":"String","fullName":"String","resultSimilarity":0}],"nationalities":[{"searchResultNationalityId":0,"nationality":"String"}],"placesOfBirth":[{"searchResultPlaceOfBirthId":0,"placeOfBirth":"String","countryOfBirth":"String"}],"remarks":[{"searchResultRemarkId":0,"name":"String","description":"String"}]}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}