| 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.*
/**
* 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
open class AddCompanySearch : IBaseRequest
{
/**
* Authentication object
*/
@DataMember
@ApiMember(DataType="Authentication", Description="Authentication object", IsRequired=true)
var Authentication:Authentication? = null
/**
* Request object
*/
@DataMember
@ApiMember(DataType="SearchCompanyRequest", Description="Request object", IsRequired=true)
var Request:SearchCompanyRequest? = null
}
@DataContract
open class Authentication : 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)
var ApiUserId:String? = 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)
var ApiUserKey:String? = null
}
open 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)
var CompanyName:String? = null
/**
* The country where the entity is registered.
*/
@ApiMember(DataType="string", Description="The country where the entity is registered.", Format="int64")
var Country:String? = null
/**
* The address where the entity is registered.
*/
@ApiMember(DataType="string", Description="The address where the entity is registered.")
var Address:String? = 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)
var SelectedSanctionsLists:ArrayOfSanctionsLists? = null
}
open class ArrayOfSanctionsLists : ArrayList<String>()
{
}
@DataContract
open class AddCompanySearchResponse
{
@DataMember
@ApiMember(IsRequired=true)
var Data:AddCompanySearchData? = null
}
@DataContract
open class AddCompanySearchData : IBaseDataResponse, IHasResponseStatus
{
@DataMember
var ResponseStatus:ResponseStatus? = null
@DataMember
var SearchRecord:SearchRecord? = null
}
open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}
open class SearchRecord
{
var Id:Long? = null
var SearchType:String? = null
var DateSearched:Date? = null
var DateUpdated:Date? = null
var NumOfResults:Int? = null
var ClientInResults:Boolean? = null
var ClientNotInResults:Boolean? = null
var AffectedByUpdate:Boolean? = null
var SearchCriteria:SearchCriteria? = null
var SearchResults:SearchResults? = null
}
open class SearchCriteria
{
var Name:String? = null
var DateOfBirth:String? = null
var CountryOfBirth:String? = null
var Nationality:String? = null
var Address:String? = null
}
open class SearchResults
{
var HMTResults:ArrayList<SearchResultHmTreasury> = ArrayList<SearchResultHmTreasury>()
var OfacResults:ArrayList<SearchResultOfac> = ArrayList<SearchResultOfac>()
}
open class SearchResultHmTreasury
{
var ResultStrength:Int? = null
var ResultSimilarity:BigDecimal? = null
var ResultResolved:Boolean? = null
var ResultType:String? = null
var DateListed:Date? = null
var DateUpdated:Date? = null
var Name1:String? = null
var Name2:String? = null
var Name3:String? = null
var Name4:String? = null
var Name5:String? = null
var Name6:String? = null
var DateOfBirth:String? = null
var CountryOfBirth:String? = null
var Nationality:String? = null
var Address1:String? = null
var Address2:String? = null
var Address3:String? = null
var Address4:String? = null
var Address5:String? = null
var Address6:String? = null
var PostCode:String? = null
var Country:String? = null
}
open class SearchResultOfac
{
var ResultStrength:Int? = null
var ResultSimilarity:BigDecimal? = null
var ResultResolved:Boolean? = null
var ResultType:String? = null
var DateUpdated:Date? = null
var FirstName:String? = null
var LastName:String? = null
var Addresses:ArrayList<SearchResultOfacAddress> = ArrayList<SearchResultOfacAddress>()
var Akas:ArrayList<SearchResultOfacAka> = ArrayList<SearchResultOfacAka>()
var DateOfBirths:ArrayList<SearchResultOfacDateOfBirth> = ArrayList<SearchResultOfacDateOfBirth>()
var Nationalities:ArrayList<SearchResultOfacNationality> = ArrayList<SearchResultOfacNationality>()
var PlaceOfBirths:ArrayList<SearchResultOfacPlaceOfBirth> = ArrayList<SearchResultOfacPlaceOfBirth>()
}
open class SearchResultOfacAddress
{
var Address1:String? = null
var Address2:String? = null
var Address3:String? = null
var City:String? = null
var State:String? = null
var PostCode:String? = null
var Country:String? = null
}
open class SearchResultOfacAka
{
var FirstName:String? = null
var LastName:String? = null
var Type:String? = null
var Strength:String? = null
}
open class SearchResultOfacDateOfBirth
{
var DateOfBirth:String? = null
}
open class SearchResultOfacNationality
{
var Country:String? = null
}
open class SearchResultOfacPlaceOfBirth
{
var PlaceOfBirth:String? = null
}
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>