GET api/search/{searchId}/filters?languageCode={languageCode} Authentication required

Use this method to get the filters specified for a search

Request

URI Parameters

NameDescriptionTypeAdditional information
searchId

Id of the search

integer

Required

languageCode

[Optional] Language represented by its ISO 639-1 Code (2 chars long). Provide this if you wish to receive the labels in another language

string

Default value is

Response

Returns the filters specified for a search

Output : object (See Model)

Ouput Sample

  • application/json, text/json :
  • { "categories": [ { "code": "017116", "name": "Restaurants", "type": "Infobel", "level": 0 }, { "code": "017116", "name": "Restaurants", "type": "Infobel", "level": 0 } ], "locations": [ { "code": "21004", "name": "Brussel", "type": "City", "level": 0 }, { "code": "21004", "name": "Brussel", "type": "City", "level": 0 } ], "dataType": 1, "pageSize": 1, "displayLanguage": "sample string 2", "detailedCounts": { "globalCounts": true, "countsPerCountry": true, "includeInfobelCategoriesCounts": true, "includeProvincesCounts": true, "includeCitiesCounts": true, "includeGeoLevelsCounts": true, "includeInternationalCategoriesCounts": true, "includeLocalCategoriesCounts": true, "includeAltInternationalCategoriesCounts": true, "includeImportExportAgentCodesCounts": true, "includeLegalStatusCodesCounts": true, "includeEmployeesRangesCounts": true, "includeSalesRangesCounts": true }, "returnFirstPage": true, "sortingOrder": [ 0, 0 ], "countryCodes": [ "sample string 1", "sample string 2" ], "who": "sample string 4", "where": "sample string 5", "uniqueIDs": [ "sample string 1", "sample string 2" ], "uniqueIDsExclusive": [ "sample string 1", "sample string 2" ], "businessName": [ "sample string 1", "sample string 2" ], "businessNameExclusive": [ "sample string 1", "sample string 2" ], "languages": [ "sample string 1", "sample string 2" ], "languagesExclusive": [ "sample string 1", "sample string 2" ], "cityCodes": [ "sample string 1", "sample string 2" ], "cityNames": [ "sample string 1", "sample string 2" ], "cityCodesExclusive": [ "sample string 1", "sample string 2" ], "provinceCodes": [ "sample string 1", "sample string 2" ], "provinceNames": [ "sample string 1", "sample string 2" ], "provinceCodesExclusive": [ "sample string 1", "sample string 2" ], "regionCodes": [ "sample string 1", "sample string 2" ], "regionNames": [ "sample string 1", "sample string 2" ], "regionCodesExclusive": [ "sample string 1", "sample string 2" ], "internationalCodes": [ "sample string 1", "sample string 2" ], "internationalCodesExclusive": [ "sample string 1", "sample string 2" ], "categoriesKeywords": [ "sample string 1", "sample string 2" ], "infobelCodes": [ "sample string 1", "sample string 2" ], "infobelCodesExclusive": [ "sample string 1", "sample string 2" ], "localCodes": [ "sample string 1", "sample string 2" ], "localCodesExclusive": [ "sample string 1", "sample string 2" ], "altInternationalCodes": [ "sample string 1", "sample string 2" ], "altInternationalCodesExclusive": [ "sample string 1", "sample string 2" ], "postCodes": [ "sample string 1", "sample string 2" ], "postCodesExclusive": [ "sample string 1", "sample string 2" ], "hasPhone": true, "hasFax": true, "hasMobile": true, "hasWebsite": true, "hasEmail": true, "hasWebContact": true, "hasContact": true, "hasPhoneDeduplicated": true, "hasEmailDeduplicated": true, "hasWebsiteDeduplicated": true, "hasMobileDeduplicated": true, "hasContactDeduplicated": true, "filterOnDNCM": true, "hasAdmin": true, "hasMarketability": true, "yearStartedFrom": "sample string 21", "yearStartedTo": "sample string 22", "salesVolumeCurrency": 0, "salesVolumeFrom": "sample string 23", "salesVolumeTo": "sample string 24", "employeesTotalFrom": "sample string 25", "employeesTotalTo": "sample string 26", "familyMembersFrom": "sample string 27", "familyMembersTo": "sample string 28", "statusCodes": [ "SingleLocation", "SingleLocation" ], "statusCodesExclusive": [ "SingleLocation", "SingleLocation" ], "coordinateOptions": [ { "latitude": 1.1, "longitude": 2.1, "distance": 3 }, { "latitude": 1.1, "longitude": 2.1, "distance": 3 } ], "coordinateOptionsExclusive": [ { "latitude": 1.1, "longitude": 2.1, "distance": 3 }, { "latitude": 1.1, "longitude": 2.1, "distance": 3 } ], "email": [ "sample string 1", "sample string 2" ], "emailExclusive": [ "sample string 1", "sample string 2" ], "website": [ "sample string 1", "sample string 2" ], "websiteExclusive": [ "sample string 1", "sample string 2" ], "nationalID": [ "sample string 1", "sample string 2" ], "nationalIDExclusive": [ "sample string 1", "sample string 2" ], "phoneNumber": [ "sample string 1", "sample string 2" ], "phoneNumberExclusive": [ "sample string 1", "sample string 2" ], "streetAddress": "sample string 29", "houseNumber": "sample string 30", "websiteIpAddress": "sample string 31", "importExportAgentCodes": [ "sample string 1", "sample string 2" ], "importExportAgentCodesExclusive": [ "sample string 1", "sample string 2" ], "legalStatusCodes": [ "sample string 1", "sample string 2" ], "legalStatusCodesExclusive": [ "sample string 1", "sample string 2" ], "ceoName": "sample string 32", "ceoTitle": "sample string 33" }
  • application/xml, text/xml :
  • <SearchInputDetailed xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Kapitol.Registered.Tools.Model"> <AltInternationalCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </AltInternationalCodes> <AltInternationalCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </AltInternationalCodesExclusive> <BusinessName xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </BusinessName> <BusinessNameExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </BusinessNameExclusive> <CEOName>sample string 32</CEOName> <CEOTitle>sample string 33</CEOTitle> <CategoriesKeywords xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </CategoriesKeywords> <CityCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </CityCodes> <CityCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </CityCodesExclusive> <CityNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </CityNames> <CoordinateOptions> <CoordinateOptions> <Distance>3</Distance> <Latitude>1.1</Latitude> <Longitude>2.1</Longitude> </CoordinateOptions> <CoordinateOptions> <Distance>3</Distance> <Latitude>1.1</Latitude> <Longitude>2.1</Longitude> </CoordinateOptions> </CoordinateOptions> <CoordinateOptionsExclusive> <CoordinateOptions> <Distance>3</Distance> <Latitude>1.1</Latitude> <Longitude>2.1</Longitude> </CoordinateOptions> <CoordinateOptions> <Distance>3</Distance> <Latitude>1.1</Latitude> <Longitude>2.1</Longitude> </CoordinateOptions> </CoordinateOptionsExclusive> <CountryCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </CountryCodes> <DataType>Business</DataType> <DetailedCounts> <CountsPerCountry>true</CountsPerCountry> <GlobalCounts>true</GlobalCounts> <IncludeAltInternationalCategoriesCounts>true</IncludeAltInternationalCategoriesCounts> <IncludeCitiesCounts>true</IncludeCitiesCounts> <IncludeEmployeesRangesCounts>true</IncludeEmployeesRangesCounts> <IncludeGeoLevelsCounts>true</IncludeGeoLevelsCounts> <IncludeImportExportAgentCodesCounts>true</IncludeImportExportAgentCodesCounts> <IncludeInfobelCategoriesCounts>true</IncludeInfobelCategoriesCounts> <IncludeInternationalCategoriesCounts>true</IncludeInternationalCategoriesCounts> <IncludeLegalStatusCodesCounts>true</IncludeLegalStatusCodesCounts> <IncludeLocalCategoriesCounts>true</IncludeLocalCategoriesCounts> <IncludeProvincesCounts>true</IncludeProvincesCounts> <IncludeSalesRangesCounts>true</IncludeSalesRangesCounts> </DetailedCounts> <DisplayLanguage>sample string 2</DisplayLanguage> <Email xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Email> <EmailExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </EmailExclusive> <EmployeesTotalFrom>sample string 25</EmployeesTotalFrom> <EmployeesTotalTo>sample string 26</EmployeesTotalTo> <FamilyMembersFrom>sample string 27</FamilyMembersFrom> <FamilyMembersTo>sample string 28</FamilyMembersTo> <FilterOnDNCM>true</FilterOnDNCM> <HasAdmin>true</HasAdmin> <HasContact>true</HasContact> <HasContactDeduplicated>true</HasContactDeduplicated> <HasEmail>true</HasEmail> <HasEmailDeduplicated>true</HasEmailDeduplicated> <HasFax>true</HasFax> <HasMarketability>true</HasMarketability> <HasMobile>true</HasMobile> <HasMobileDeduplicated>true</HasMobileDeduplicated> <HasPhone>true</HasPhone> <HasPhoneDeduplicated>true</HasPhoneDeduplicated> <HasWebContact>true</HasWebContact> <HasWebsite>true</HasWebsite> <HasWebsiteDeduplicated>true</HasWebsiteDeduplicated> <HouseNumber>sample string 30</HouseNumber> <ImportExportAgentCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ImportExportAgentCodes> <ImportExportAgentCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ImportExportAgentCodesExclusive> <InfobelCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </InfobelCodes> <InfobelCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </InfobelCodesExclusive> <InternationalCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </InternationalCodes> <InternationalCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </InternationalCodesExclusive> <Languages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Languages> <LanguagesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </LanguagesExclusive> <LegalStatusCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </LegalStatusCodes> <LegalStatusCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </LegalStatusCodesExclusive> <LocalCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </LocalCodes> <LocalCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </LocalCodesExclusive> <NationalID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </NationalID> <NationalIDExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </NationalIDExclusive> <PageSize>1</PageSize> <PhoneNumber xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </PhoneNumber> <PhoneNumberExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </PhoneNumberExclusive> <PostCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </PostCodes> <PostCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </PostCodesExclusive> <ProvinceCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ProvinceCodes> <ProvinceCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ProvinceCodesExclusive> <ProvinceNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ProvinceNames> <RegionCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </RegionCodes> <RegionCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </RegionCodesExclusive> <RegionNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </RegionNames> <ReturnFirstPage>true</ReturnFirstPage> <SalesVolumeCurrency>Local</SalesVolumeCurrency> <SalesVolumeFrom>sample string 23</SalesVolumeFrom> <SalesVolumeTo>sample string 24</SalesVolumeTo> <SortingOrder xmlns:d2p1="http://schemas.datacontract.org/2004/07/Kapitol.Registered.Search.Models"> <d2p1:Enums.SortingOrder>UniqueId</d2p1:Enums.SortingOrder> <d2p1:Enums.SortingOrder>UniqueId</d2p1:Enums.SortingOrder> </SortingOrder> <StatusCodes> <BusinessStatusCode>SingleLocation</BusinessStatusCode> <BusinessStatusCode>SingleLocation</BusinessStatusCode> </StatusCodes> <StatusCodesExclusive> <BusinessStatusCode>SingleLocation</BusinessStatusCode> <BusinessStatusCode>SingleLocation</BusinessStatusCode> </StatusCodesExclusive> <StreetAddress>sample string 29</StreetAddress> <UniqueIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </UniqueIDs> <UniqueIDsExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </UniqueIDsExclusive> <Website xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Website> <WebsiteExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </WebsiteExclusive> <WebsiteIpAddress>sample string 31</WebsiteIpAddress> <Where>sample string 5</Where> <Who>sample string 4</Who> <YearStartedFrom>sample string 21</YearStartedFrom> <YearStartedTo>sample string 22</YearStartedTo> <Categories> <Category xmlns=""> <Code>017116</Code> <CountryCode i:nil="true" /> <Level>0</Level> <Name>Restaurants</Name> <ParentCode i:nil="true" /> <Type>Infobel</Type> </Category> <Category xmlns=""> <Code>017116</Code> <CountryCode i:nil="true" /> <Level>0</Level> <Name>Restaurants</Name> <ParentCode i:nil="true" /> <Type>Infobel</Type> </Category> </Categories> <Locations> <Location xmlns=""> <Code>21004</Code> <CountryCode i:nil="true" /> <FullName i:nil="true" /> <Level>0</Level> <Name>Brussel</Name> <ParentCode i:nil="true" /> <ParentName i:nil="true" /> <Type>City</Type> </Location> <Location xmlns=""> <Code>21004</Code> <CountryCode i:nil="true" /> <FullName i:nil="true" /> <Level>0</Level> <Name>Brussel</Name> <ParentCode i:nil="true" /> <ParentName i:nil="true" /> <Type>City</Type> </Location> </Locations> </SearchInputDetailed>