| POST | /companylookups/list | Get all company lookups |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@DataContract
public static class GetCompanyLookups extends BaseRequest
{
@DataMember
public GetCompanyLookupsRequest request = null;
public GetCompanyLookupsRequest getRequest() { return request; }
public GetCompanyLookups setRequest(GetCompanyLookupsRequest 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 GetCompanyLookupsRequest
{
/**
* 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 Boolean listIncompleteSearches = null;
public Integer page = null;
public String sortOrder = null;
public String nameSearch = null;
public String filterReference = 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 GetCompanyLookupsRequest setSubUserName(String value) { this.subUserName = value; return this; }
public Boolean isListIncompleteSearches() { return listIncompleteSearches; }
public GetCompanyLookupsRequest setListIncompleteSearches(Boolean value) { this.listIncompleteSearches = value; return this; }
public Integer getPage() { return page; }
public GetCompanyLookupsRequest setPage(Integer value) { this.page = value; return this; }
public String getSortOrder() { return sortOrder; }
public GetCompanyLookupsRequest setSortOrder(String value) { this.sortOrder = value; return this; }
public String getNameSearch() { return nameSearch; }
public GetCompanyLookupsRequest setNameSearch(String value) { this.nameSearch = value; return this; }
public String getFilterReference() { return filterReference; }
public GetCompanyLookupsRequest setFilterReference(String value) { this.filterReference = value; return this; }
public Date getFilterDateFrom() { return filterDateFrom; }
public GetCompanyLookupsRequest setFilterDateFrom(Date value) { this.filterDateFrom = value; return this; }
public Date getFilterDateTo() { return filterDateTo; }
public GetCompanyLookupsRequest setFilterDateTo(Date value) { this.filterDateTo = value; return this; }
public String getFilterUserName() { return filterUserName; }
public GetCompanyLookupsRequest setFilterUserName(String value) { this.filterUserName = value; return this; }
}
@DataContract
public static class GetCompanyLookupsResponse
{
@DataMember
public GetCompanyLookupsData data = null;
public GetCompanyLookupsData getData() { return data; }
public GetCompanyLookupsResponse setData(GetCompanyLookupsData value) { this.data = value; return this; }
}
public static class GetCompanyLookupsData extends BaseResponse
{
public Integer totalRecords = null;
public Integer currentPageNum = null;
public Integer maxPageNum = null;
public ArrayOfCompanyLookupListItem companyLookupRecords = null;
public Integer getTotalRecords() { return totalRecords; }
public GetCompanyLookupsData setTotalRecords(Integer value) { this.totalRecords = value; return this; }
public Integer getCurrentPageNum() { return currentPageNum; }
public GetCompanyLookupsData setCurrentPageNum(Integer value) { this.currentPageNum = value; return this; }
public Integer getMaxPageNum() { return maxPageNum; }
public GetCompanyLookupsData setMaxPageNum(Integer value) { this.maxPageNum = value; return this; }
public ArrayOfCompanyLookupListItem getCompanyLookupRecords() { return companyLookupRecords; }
public GetCompanyLookupsData setCompanyLookupRecords(ArrayOfCompanyLookupListItem value) { this.companyLookupRecords = 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 ArrayOfCompanyLookupListItem extends ArrayList<CompanyLookupListItem>
{
}
public static class CompanyLookupListItem
{
public Integer id = null;
public SearchCriteria searchCriteria = null;
public ArrayOfLists selectedLists = null;
public Date date = null;
public Boolean hasCompanyId = null;
public Boolean hasCompanyDetails = null;
public Boolean hasStartedSearches = null;
public Boolean hasCompletedSearches = null;
public Integer getId() { return id; }
public CompanyLookupListItem setId(Integer value) { this.id = value; return this; }
public SearchCriteria getSearchCriteria() { return searchCriteria; }
public CompanyLookupListItem setSearchCriteria(SearchCriteria value) { this.searchCriteria = value; return this; }
public ArrayOfLists getSelectedLists() { return selectedLists; }
public CompanyLookupListItem setSelectedLists(ArrayOfLists value) { this.selectedLists = value; return this; }
public Date getDate() { return date; }
public CompanyLookupListItem setDate(Date value) { this.date = value; return this; }
public Boolean isHasCompanyId() { return hasCompanyId; }
public CompanyLookupListItem setHasCompanyId(Boolean value) { this.hasCompanyId = value; return this; }
public Boolean isHasCompanyDetails() { return hasCompanyDetails; }
public CompanyLookupListItem setHasCompanyDetails(Boolean value) { this.hasCompanyDetails = value; return this; }
public Boolean isHasStartedSearches() { return hasStartedSearches; }
public CompanyLookupListItem setHasStartedSearches(Boolean value) { this.hasStartedSearches = value; return this; }
public Boolean isHasCompletedSearches() { return hasCompletedSearches; }
public CompanyLookupListItem setHasCompletedSearches(Boolean value) { this.hasCompletedSearches = 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 ArrayOfLists extends ArrayList<String>
{
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /companylookups/list HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetCompanyLookups xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Authentication>
<ApiUserId>String</ApiUserId>
<ApiUserKey>String</ApiUserKey>
</Authentication>
<Request>
<FilterDateFrom>0001-01-01T00:00:00</FilterDateFrom>
<FilterDateTo>0001-01-01T00:00:00</FilterDateTo>
<FilterReference>String</FilterReference>
<FilterUserName>String</FilterUserName>
<ListIncompleteSearches>false</ListIncompleteSearches>
<NameSearch>String</NameSearch>
<Page>0</Page>
<SortOrder>String</SortOrder>
<SubUserName>String</SubUserName>
</Request>
</GetCompanyLookups>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetCompanyLookupsResponse 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>
<CompanyLookupRecords>
<CompanyLookupRecord>
<Date>0001-01-01T00:00:00</Date>
<HasCompanyDetails>false</HasCompanyDetails>
<HasCompanyId>false</HasCompanyId>
<HasCompletedSearches>false</HasCompletedSearches>
<HasStartedSearches>false</HasStartedSearches>
<Id>0</Id>
<SearchCriteria>
<Address>String</Address>
<Country>String</Country>
<DateOfBirth>String</DateOfBirth>
<Name>String</Name>
<Nationality>String</Nationality>
<Reference>String</Reference>
</SearchCriteria>
<SelectedLists>
<ListId>String</ListId>
</SelectedLists>
</CompanyLookupRecord>
</CompanyLookupRecords>
<CurrentPageNum>0</CurrentPageNum>
<MaxPageNum>0</MaxPageNum>
<TotalRecords>0</TotalRecords>
</Data>
</GetCompanyLookupsResponse>