| Create a new sanctions search for an entity | This will create a new sanctions search for an entity, such as a company, vessel, organisation, or group. |
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* Create a new sanctions search for an entity
*/
@Api(Description="Create a new sanctions search for an entity")
@ApiResponse(Description="Your request is successful if the \"<em>Data.ResponseStatus.Message</em>\" field is \"<b>Success</b>\".", StatusCode=200)
@DataContract
public static class AddCompanySearch implements IBaseRequest
{
/**
* Authentication object
*/
@DataMember
@ApiMember(DataType="Authentication", Description="Authentication object", IsRequired=true)
public Authentication Authentication = null;
/**
* Request object
*/
@DataMember
@ApiMember(DataType="SearchCompanyRequest", Description="Request object", IsRequired=true)
public SearchCompanyRequest Request = null;
public Authentication getAuthentication() { return Authentication; }
public AddCompanySearch setAuthentication(Authentication value) { this.Authentication = value; return this; }
public SearchCompanyRequest getRequest() { return Request; }
public AddCompanySearch setRequest(SearchCompanyRequest value) { this.Request = value; return this; }
}
@DataContract
public static class Authentication implements IAuthentication
{
/**
* The API User ID that will authenticate your request
*/
@DataMember
@ApiMember(DataType="string", Description="The API User ID that will authenticate your request", IsRequired=true)
public String ApiUserId = null;
/**
* The API User Key that will authenticate your request
*/
@DataMember
@ApiMember(DataType="string", Description="The API User Key that will authenticate your request", IsRequired=true)
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 SearchCompanyRequest
{
/**
* The name of the entity that is being searched.
*/
@ApiMember(DataType="string", Description="The name of the entity that is being searched.", IsRequired=true)
public String CompanyName = null;
/**
* The country where the entity is registered.
*/
@ApiMember(DataType="string", Description="The country where the entity is registered.", Format="int64")
public String Country = null;
/**
* The address where the entity is registered.
*/
@ApiMember(DataType="string", Description="The address where the entity is registered.")
public String Address = null;
/**
* Array of sanctions lists to be included in the search. At least one is required.
*/
@ApiMember(DataType="ArrayOfSanctionsLists", Description="Array of sanctions lists to be included in the search. At least one is required.", IsRequired=true)
public ArrayOfSanctionsLists SelectedSanctionsLists = null;
public String getCompanyName() { return CompanyName; }
public SearchCompanyRequest setCompanyName(String value) { this.CompanyName = value; return this; }
public String getCountry() { return Country; }
public SearchCompanyRequest setCountry(String value) { this.Country = value; return this; }
public String getAddress() { return Address; }
public SearchCompanyRequest setAddress(String value) { this.Address = value; return this; }
public ArrayOfSanctionsLists getSelectedSanctionsLists() { return SelectedSanctionsLists; }
public SearchCompanyRequest setSelectedSanctionsLists(ArrayOfSanctionsLists value) { this.SelectedSanctionsLists = value; return this; }
}
public static class ArrayOfSanctionsLists extends ArrayList<String>
{
}
@DataContract
public static class AddCompanySearchResponse
{
@DataMember
@ApiMember(IsRequired=true)
public AddCompanySearchData Data = null;
public AddCompanySearchData getData() { return Data; }
public AddCompanySearchResponse setData(AddCompanySearchData value) { this.Data = value; return this; }
}
@DataContract
public static class AddCompanySearchData implements IBaseDataResponse, IHasResponseStatus
{
@DataMember
public ResponseStatus ResponseStatus = null;
@DataMember
public SearchRecord SearchRecord = null;
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public AddCompanySearchData setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
public SearchRecord getSearchRecord() { return SearchRecord; }
public AddCompanySearchData setSearchRecord(SearchRecord value) { this.SearchRecord = value; return this; }
}
public static class ArrayOfResponseError extends ArrayList<ResponseError>
{
}
public static class SearchRecord
{
public Long Id = null;
public String SearchType = null;
public Date DateSearched = null;
public Date DateUpdated = 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 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 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 static class SearchCriteria
{
public String Name = null;
public String DateOfBirth = null;
public String CountryOfBirth = null;
public String Nationality = null;
public String Address = null;
public String getName() { return Name; }
public SearchCriteria setName(String value) { this.Name = value; return this; }
public String getDateOfBirth() { return DateOfBirth; }
public SearchCriteria setDateOfBirth(String value) { this.DateOfBirth = value; return this; }
public String getCountryOfBirth() { return CountryOfBirth; }
public SearchCriteria setCountryOfBirth(String value) { this.CountryOfBirth = value; return this; }
public String getNationality() { return Nationality; }
public SearchCriteria setNationality(String value) { this.Nationality = value; return this; }
public String getAddress() { return Address; }
public SearchCriteria setAddress(String value) { this.Address = value; return this; }
}
public static class SearchResults
{
public ArrayList<SearchResultHmTreasury> HMTResults = null;
public ArrayList<SearchResultOfac> OfacResults = null;
public ArrayList<SearchResultHmTreasury> getHmtResults() { return HMTResults; }
public SearchResults setHmtResults(ArrayList<SearchResultHmTreasury> value) { this.HMTResults = value; return this; }
public ArrayList<SearchResultOfac> getOfacResults() { return OfacResults; }
public SearchResults setOfacResults(ArrayList<SearchResultOfac> value) { this.OfacResults = 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: AddCompanySearch
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AddCompanySearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<Address>String</Address>
<CompanyName>String</CompanyName>
<Country>String</Country>
<SelectedSanctionsLists>
<SanctionsListId>String</SanctionsListId>
</SelectedSanctionsLists>
</Request>
</AddCompanySearch>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AddCompanySearchResponse 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>
</ResponseError>
</Errors>
</ResponseStatus>
<SearchRecord>
<AffectedByUpdate>false</AffectedByUpdate>
<ClientInResults>false</ClientInResults>
<ClientNotInResults>false</ClientNotInResults>
<DateSearched>0001-01-01T00:00:00</DateSearched>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Id>0</Id>
<NumOfResults>0</NumOfResults>
<SearchCriteria>
<Address>String</Address>
<CountryOfBirth>String</CountryOfBirth>
<DateOfBirth>String</DateOfBirth>
<Name>String</Name>
<Nationality>String</Nationality>
</SearchCriteria>
<SearchResults>
<HMTResults>
<SearchResultHmTreasury>
<Address1>String</Address1>
<Address2>String</Address2>
<Address3>String</Address3>
<Address4>String</Address4>
<Address5>String</Address5>
<Address6>String</Address6>
<Country>String</Country>
<CountryOfBirth>String</CountryOfBirth>
<DateListed>0001-01-01T00:00:00</DateListed>
<DateOfBirth>String</DateOfBirth>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<Name1>String</Name1>
<Name2>String</Name2>
<Name3>String</Name3>
<Name4>String</Name4>
<Name5>String</Name5>
<Name6>String</Name6>
<Nationality>String</Nationality>
<PostCode>String</PostCode>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
</SearchResultHmTreasury>
</HMTResults>
<OfacResults>
<SearchResultOfac>
<Addresses>
<SearchResultOfacAddress>
<Address1>String</Address1>
<Address2>String</Address2>
<Address3>String</Address3>
<City>String</City>
<Country>String</Country>
<PostCode>String</PostCode>
<State>String</State>
</SearchResultOfacAddress>
</Addresses>
<Akas>
<SearchResultOfacAka>
<FirstName>String</FirstName>
<LastName>String</LastName>
<Strength>String</Strength>
<Type>String</Type>
</SearchResultOfacAka>
</Akas>
<DateOfBirths>
<SearchResultOfacDateOfBirth>
<DateOfBirth>String</DateOfBirth>
</SearchResultOfacDateOfBirth>
</DateOfBirths>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
<FirstName>String</FirstName>
<LastName>String</LastName>
<Nationalities>
<SearchResultOfacNationality>
<Country>String</Country>
</SearchResultOfacNationality>
</Nationalities>
<PlaceOfBirths>
<SearchResultOfacPlaceOfBirth>
<PlaceOfBirth>String</PlaceOfBirth>
</SearchResultOfacPlaceOfBirth>
</PlaceOfBirths>
<ResultResolved>false</ResultResolved>
<ResultSimilarity>0</ResultSimilarity>
<ResultStrength>0</ResultStrength>
<ResultType>String</ResultType>
</SearchResultOfac>
</OfacResults>
</SearchResults>
<SearchType>String</SearchType>
</SearchRecord>
</Data>
</AddCompanySearchResponse>
</soap:Body>
</soap:Envelope>