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

string

Default value is EN

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": true, "sortingOrder": [ 0, 0 ], "countryCodes": [ "sample string 1", "sample string 2" ], "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" ], "cityCodesExclusive": [ "sample string 1", "sample string 2" ], "provinceCodes": [ "sample string 1", "sample string 2" ], "provinceCodesExclusive": [ "sample string 1", "sample string 2" ], "regionCodes": [ "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" ], "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" ], "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, "hasMobileDeduplicated": true, "hasContactDeduplicated": true, "filterOnDNCM": true, "hasAdmin": true, "yearStartedFrom": "sample string 17", "yearStartedTo": "sample string 18", "salesVolumeFrom": "sample string 19", "salesVolumeTo": "sample string 20", "employeesTotalFrom": "sample string 21", "employeesTotalTo": "sample string 22", "familyMembersFrom": "sample string 23", "familyMembersTo": "sample string 24", "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 25", "website": "sample string 26", "nationalID": "sample string 27", "phoneNumber": "sample string 28", "streetAddress": "sample string 29", "houseNumber": "sample string 30", "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 31", "ceoTitle": "sample string 32" }
  • 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"> <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 31</CEOName> <CEOTitle>sample string 32</CEOTitle> <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> <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>true</DetailedCounts> <DisplayLanguage>sample string 2</DisplayLanguage> <Email>sample string 25</Email> <EmployeesTotalFrom>sample string 21</EmployeesTotalFrom> <EmployeesTotalTo>sample string 22</EmployeesTotalTo> <FamilyMembersFrom>sample string 23</FamilyMembersFrom> <FamilyMembersTo>sample string 24</FamilyMembersTo> <FilterOnDNCM>true</FilterOnDNCM> <HasAdmin>true</HasAdmin> <HasContact>true</HasContact> <HasContactDeduplicated>true</HasContactDeduplicated> <HasEmail>true</HasEmail> <HasEmailDeduplicated>true</HasEmailDeduplicated> <HasFax>true</HasFax> <HasMobile>true</HasMobile> <HasMobileDeduplicated>true</HasMobileDeduplicated> <HasPhone>true</HasPhone> <HasPhoneDeduplicated>true</HasPhoneDeduplicated> <HasWebContact>true</HasWebContact> <HasWebsite>true</HasWebsite> <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>sample string 27</NationalID> <PageSize>1</PageSize> <PhoneNumber>sample string 28</PhoneNumber> <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> <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> <SalesVolumeFrom>sample string 19</SalesVolumeFrom> <SalesVolumeTo>sample string 20</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>sample string 26</Website> <YearStartedFrom>sample string 17</YearStartedFrom> <YearStartedTo>sample string 18</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" /> <Level>0</Level> <Name>Brussel</Name> <ParentCode i:nil="true" /> <Type>City</Type> </Location> <Location xmlns=""> <Code>21004</Code> <CountryCode i:nil="true" /> <Level>0</Level> <Name>Brussel</Name> <ParentCode i:nil="true" /> <Type>City</Type> </Location> </Locations> </SearchInputDetailed>