Sanctions Search API: v2

<back to all web services

SearchCompanyLookup

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class SearchCompanyLookup extends BaseRequest
    {
        @DataMember
        public SearchCompanyLookupRequest request = null;
        
        public SearchCompanyLookupRequest getRequest() { return request; }
        public SearchCompanyLookup setRequest(SearchCompanyLookupRequest 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 SearchCompanyLookupRequest
    {
        public String companyName = null;
        public String companyCountry = null;
        public Boolean autocompleteMode = null;
        
        public String getCompanyName() { return companyName; }
        public SearchCompanyLookupRequest setCompanyName(String value) { this.companyName = value; return this; }
        public String getCompanyCountry() { return companyCountry; }
        public SearchCompanyLookupRequest setCompanyCountry(String value) { this.companyCountry = value; return this; }
        public Boolean isAutocompleteMode() { return autocompleteMode; }
        public SearchCompanyLookupRequest setAutocompleteMode(Boolean value) { this.autocompleteMode = value; return this; }
    }

    @DataContract
    public static class SearchCompanyLookupResponse
    {
        @DataMember
        public SearchCompanyLookupData data = null;
        
        public SearchCompanyLookupData getData() { return data; }
        public SearchCompanyLookupResponse setData(SearchCompanyLookupData value) { this.data = value; return this; }
    }

    public static class SearchCompanyLookupData extends BaseResponse
    {
        public ArrayOfCompanySearchResult searchResults = null;
        
        public ArrayOfCompanySearchResult getSearchResults() { return searchResults; }
        public SearchCompanyLookupData setSearchResults(ArrayOfCompanySearchResult value) { this.searchResults = 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 ArrayOfCompanySearchResult extends ArrayList<CompanySearchResultItem>
    {
        
    }

    public static class CompanySearchResultItem
    {
        public String id = null;
        public String number = null;
        public String name = null;
        public String address = null;
        public String country = null;
        public String status = null;
        
        public String getId() { return id; }
        public CompanySearchResultItem setId(String value) { this.id = value; return this; }
        public String getNumber() { return number; }
        public CompanySearchResultItem setNumber(String value) { this.number = value; return this; }
        public String getName() { return name; }
        public CompanySearchResultItem setName(String value) { this.name = value; return this; }
        public String getAddress() { return address; }
        public CompanySearchResultItem setAddress(String value) { this.address = value; return this; }
        public String getCountry() { return country; }
        public CompanySearchResultItem setCountry(String value) { this.country = value; return this; }
        public String getStatus() { return status; }
        public CompanySearchResultItem setStatus(String value) { this.status = value; return this; }
    }

}

Java SearchCompanyLookup DTOs

POST /companylookups/search HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SearchCompanyLookup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <AutocompleteMode>false</AutocompleteMode>
    <CompanyCountry>String</CompanyCountry>
    <CompanyName>String</CompanyName>
  </Request>
</SearchCompanyLookup>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchCompanyLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Data>
    <ResponseStatus>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
          <Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Meta>
        </ResponseError>
      </Errors>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseStatus>
    <SearchResults>
      <Company>
        <Address>String</Address>
        <Country>String</Country>
        <Id>String</Id>
        <Name>String</Name>
        <Number>String</Number>
        <Status>String</Status>
      </Company>
    </SearchResults>
  </Data>
</SearchCompanyLookupResponse>