GET api/search/{searchId}/filters?languageCode={languageCode} Authentication required
Use this method to get the filters specified for a search
Request
URI Parameters
| Name | Description | Type | Additional 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
{
"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": 2,
"pageSize": 1,
"displayLanguage": "sample string 2",
"internationalPhoneFormat": true,
"detailedCounts": {
"globalCounts": true,
"countsPerCountry": true,
"includeInfobelCategoriesCounts": true,
"includeRegionsCounts": true,
"includeProvincesCounts": true,
"includeCitiesCounts": true,
"includePostCodesCounts": true,
"includeGeoLevelsCounts": true,
"includeInternationalCategoriesCounts": true,
"includeLocalCategoriesCounts": true
},
"returnFirstPage": true,
"sortingOrder": [
0,
0
],
"countryCodes": [
"sample string 1",
"sample string 2"
],
"who": "sample string 5",
"where": "sample string 6",
"tryAnyLocationMatch": true,
"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"
],
"restrictOnMainCategory": true,
"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"
],
"hasAddress": true,
"hasPhone": true,
"hasFax": true,
"hasMobile": true,
"hasWebsite": 0,
"hasNationalID": true,
"hasEmail": true,
"hasWebContact": true,
"hasContact": true,
"hasCoordinates": true,
"hasPhoneDeduplicated": true,
"hasEmailDeduplicated": true,
"hasWebsiteDeduplicated": true,
"hasNationalIDDeduplicated": true,
"hasMobileDeduplicated": true,
"hasContactDeduplicated": true,
"filterOnDNCM": true,
"geoLevels": [
1,
2
],
"geoLevelsExclusive": [
1,
2
],
"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 24",
"houseNumber": "sample string 25"
}
<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>
<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>
<DetailedCounts>
<CountsPerCountry>true</CountsPerCountry>
<GlobalCounts>true</GlobalCounts>
<IncludeCitiesCounts>true</IncludeCitiesCounts>
<IncludeGeoLevelsCounts>true</IncludeGeoLevelsCounts>
<IncludeInfobelCategoriesCounts>true</IncludeInfobelCategoriesCounts>
<IncludeInternationalCategoriesCounts>true</IncludeInternationalCategoriesCounts>
<IncludeLocalCategoriesCounts>true</IncludeLocalCategoriesCounts>
<IncludePostCodesCounts>true</IncludePostCodesCounts>
<IncludeProvincesCounts>true</IncludeProvincesCounts>
<IncludeRegionsCounts>true</IncludeRegionsCounts>
</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>
<FilterOnDNCM>true</FilterOnDNCM>
<GeoLevels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</GeoLevels>
<GeoLevelsExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</GeoLevelsExclusive>
<HasAddress>true</HasAddress>
<HasContact>true</HasContact>
<HasContactDeduplicated>true</HasContactDeduplicated>
<HasCoordinates>true</HasCoordinates>
<HasEmail>true</HasEmail>
<HasEmailDeduplicated>true</HasEmailDeduplicated>
<HasFax>true</HasFax>
<HasMobile>true</HasMobile>
<HasMobileDeduplicated>true</HasMobileDeduplicated>
<HasNationalID>true</HasNationalID>
<HasNationalIDDeduplicated>true</HasNationalIDDeduplicated>
<HasPhone>true</HasPhone>
<HasPhoneDeduplicated>true</HasPhoneDeduplicated>
<HasWebContact>true</HasWebContact>
<HasWebsite>Ignore</HasWebsite>
<HasWebsiteDeduplicated>true</HasWebsiteDeduplicated>
<HouseNumber>sample string 25</HouseNumber>
<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>
<InternationalPhoneFormat>true</InternationalPhoneFormat>
<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>
<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>
<RestrictOnMainCategory>true</RestrictOnMainCategory>
<ReturnFirstPage>true</ReturnFirstPage>
<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>
<StreetAddress>sample string 24</StreetAddress>
<TryAnyLocationMatch>true</TryAnyLocationMatch>
<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>
<Where>sample string 6</Where>
<Who>sample string 5</Who>
<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>