ConsumerApi

<back to all web services

FindAvailableFilterRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/find/filtering
FindAvailableFilterRequest Parameters:
NameParameterData TypeRequiredDescription
FilterqueryQueryFilterDtoYes
LocationqueryQueryLocationDtoYes
CacheVersionquerylong?No
QueryFilterDto Parameters:
NameParameterData TypeRequiredDescription
TermformstringNo
PlaceGuidformGuid?No
AdMessageGuidformGuid?No
CategoryAbsoluteSlugsformList<string>No
BarSpecialitySlugsformList<string>No
BarTypeSlugsformList<string>No
BrandNamesformList<string>No
CuisineSlugsformList<string>No
MealTypeSlugsformList<string>No
ParkingformList<Parking>No
PaymentOptionsformList<PaymentOption>No
PriceMainDishesformList<PriceMainDish>No
EatingSuitabilitySlugsformList<string>No
TakeAwaySlugsformList<string>No
WearPriceProfileSlugsformList<string>No
WheelChairAccessibleformbool?No
Wififormbool?No
OutdoorSeatingformbool?No
SaveFoodAndMoneyformbool?No
OpenAtformOpenAtTimeDtoNo
Parking Enum:
StreetParking
ParkingGarageNearby
PaymentOption Enum:
Visa
MasterCard
AmericanExpress
Diners
Vipps
PriceMainDish Enum:
Value
Medium
High
FineDining
OpenAtTimeDto Parameters:
NameParameterData TypeRequiredDescription
WeekDayformDayOfWeekNo
HourformintNo
MinuteformintNo
DayOfWeek Enum:
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
QueryLocationDto Parameters:
NameParameterData TypeRequiredDescription
Longitudeformfloat?No
Latitudeformfloat?No
SearchRadiusInKmformfloat?No
FindAvailableFilterResponse Parameters:
NameParameterData TypeRequiredDescription
BarTypesformList<BarTypeCountDto>Yes
BarSpecialitiesformList<BarSpecialityCountDto>Yes
BrandsformList<BrandCountDto>Yes
CuisinesformList<CuisineCountDto>Yes
MealTypeformList<MealTypeCountDto>Yes
EatingSuitabilitiesformList<EatingSuitabilityCountDto>Yes
ParkingsformList<ParkingCountDto>Yes
PaymentOptionsformList<PaymentOptionCountDto>Yes
PriceMainDishesformList<PriceMainDishCountDto>Yes
TakeAwaysformList<TakeAwayCountDto>Yes
WearPriceProfilesformList<WearPriceProfileCountDto>Yes
CategoriesformList<CategoryFacetTreeDto>Yes
BarTypeCountDto Parameters:
NameParameterData TypeRequiredDescription
CountformlongNo
BarTypeDto Parameters:
NameParameterData TypeRequiredDescription
SlugformstringYes
TitleformstringYes
BarSpecialityCountDto Parameters:
NameParameterData TypeRequiredDescription
CountformlongNo
BarSpecialityDto Parameters:
NameParameterData TypeRequiredDescription
SlugformstringYes
TitleformstringYes
BrandCountDto Parameters:
NameParameterData TypeRequiredDescription
CountformlongNo
BrandDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
CuisineCountDto Parameters:
NameParameterData TypeRequiredDescription
CountformlongNo
CuisineDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformstringYes
MealTypeCountDto Parameters:
NameParameterData TypeRequiredDescription
CountformlongNo
MealTypeDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformstringYes
EatingSuitabilityCountDto Parameters:
NameParameterData TypeRequiredDescription
CountformlongNo
EatingSuitabilityDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformstringYes
ParkingCountDto Parameters:
NameParameterData TypeRequiredDescription
CountformlongNo
ParkingDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformParkingNo
PaymentOptionCountDto Parameters:
NameParameterData TypeRequiredDescription
CountformlongNo
PaymentOptionDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformPaymentOptionNo
PriceMainDishCountDto Parameters:
NameParameterData TypeRequiredDescription
CountformlongNo
PriceMainDishDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes
SlugformPriceMainDishNo
TakeAwayCountDto Parameters:
NameParameterData TypeRequiredDescription
CountformlongNo
TakeAwayDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformstringYes
WearPriceProfileCountDto Parameters:
NameParameterData TypeRequiredDescription
CountformlongNo
WearPriceProfileDto Parameters:
NameParameterData TypeRequiredDescription
SlugformstringYes
LabelformstringYes
CategoryFacetTreeDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
SlugformstringYes
AbsoluteSlugformstringYes
FeatureTypesformList<FeatureType>No
TypeformCategoryFacetTreeTypeNo
Countformlong?No
ImageUrlformstringNo
AllImageUrlformstringNo
IconImageUrlformstringNo
PositionformintNo
ChildrenformList<CategoryFacetTreeDto>No
FeatureType Enum:
BarSpeciality
BarType
Cuisine
SaveFoodAndMoney
MealType
Menu
OutdoorSeating
Parking
PaymentOptions
PriceMainDish
SubCategories
SubCategoriesAndBrands
EatingSuitabilities
TakeAway
WearPriceProfile
WheelChairAccessible
Wifi
WebShop
Filtering
CategoryFacetTreeType Enum:
Parent
Selected
Available

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /find/filtering HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FindAvailableFilterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <BarSpecialities>
    <BarSpecialityCountDto>
      <Slug>String</Slug>
      <Title>String</Title>
      <Count>0</Count>
    </BarSpecialityCountDto>
  </BarSpecialities>
  <BarTypes>
    <BarTypeCountDto>
      <Slug>String</Slug>
      <Title>String</Title>
      <Count>0</Count>
    </BarTypeCountDto>
  </BarTypes>
  <Brands>
    <BrandCountDto>
      <Name>String</Name>
      <Count>0</Count>
    </BrandCountDto>
  </Brands>
  <Categories>
    <CategoryFacetTreeDto>
      <AbsoluteSlug>String</AbsoluteSlug>
      <AllImageUrl>String</AllImageUrl>
      <Children>
        <CategoryFacetTreeDto>
          <AbsoluteSlug>String</AbsoluteSlug>
          <AllImageUrl>String</AllImageUrl>
          <Children>
            <CategoryFacetTreeDto>
              <AbsoluteSlug>String</AbsoluteSlug>
              <AllImageUrl>String</AllImageUrl>
              <Children i:nil="true" />
              <Count>0</Count>
              <FeatureTypes xmlns:d8p1="http://schemas.datacontract.org/2004/07/Entities.Database">
                <d8p1:FeatureType>BarSpeciality</d8p1:FeatureType>
              </FeatureTypes>
              <IconImageUrl>String</IconImageUrl>
              <ImageUrl>String</ImageUrl>
              <Name>String</Name>
              <Position>0</Position>
              <Slug>String</Slug>
              <Type>Parent</Type>
            </CategoryFacetTreeDto>
          </Children>
          <Count>0</Count>
          <FeatureTypes xmlns:d6p1="http://schemas.datacontract.org/2004/07/Entities.Database">
            <d6p1:FeatureType>BarSpeciality</d6p1:FeatureType>
          </FeatureTypes>
          <IconImageUrl>String</IconImageUrl>
          <ImageUrl>String</ImageUrl>
          <Name>String</Name>
          <Position>0</Position>
          <Slug>String</Slug>
          <Type>Parent</Type>
        </CategoryFacetTreeDto>
      </Children>
      <Count>0</Count>
      <FeatureTypes xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Database">
        <d4p1:FeatureType>BarSpeciality</d4p1:FeatureType>
      </FeatureTypes>
      <IconImageUrl>String</IconImageUrl>
      <ImageUrl>String</ImageUrl>
      <Name>String</Name>
      <Position>0</Position>
      <Slug>String</Slug>
      <Type>Parent</Type>
    </CategoryFacetTreeDto>
  </Categories>
  <Cuisines>
    <CuisineCountDto>
      <Label>String</Label>
      <Slug>String</Slug>
      <Count>0</Count>
    </CuisineCountDto>
  </Cuisines>
  <EatingSuitabilities>
    <EatingSuitabilityCountDto>
      <Label>String</Label>
      <Slug>String</Slug>
      <Count>0</Count>
    </EatingSuitabilityCountDto>
  </EatingSuitabilities>
  <MealType>
    <MealTypeCountDto>
      <Label>String</Label>
      <Slug>String</Slug>
      <Count>0</Count>
    </MealTypeCountDto>
  </MealType>
  <Parkings>
    <ParkingCountDto>
      <Label>String</Label>
      <Slug>StreetParking</Slug>
      <Count>0</Count>
    </ParkingCountDto>
  </Parkings>
  <PaymentOptions>
    <PaymentOptionCountDto>
      <Label>String</Label>
      <Slug>Visa</Slug>
      <Count>0</Count>
    </PaymentOptionCountDto>
  </PaymentOptions>
  <PriceMainDishes>
    <PriceMainDishCountDto>
      <Slug>Value</Slug>
      <Title>String</Title>
      <Count>0</Count>
    </PriceMainDishCountDto>
  </PriceMainDishes>
  <TakeAways>
    <TakeAwayCountDto>
      <Label>String</Label>
      <Slug>String</Slug>
      <Count>0</Count>
    </TakeAwayCountDto>
  </TakeAways>
  <WearPriceProfiles>
    <WearPriceProfileCountDto>
      <Label>String</Label>
      <Slug>String</Slug>
      <Count>0</Count>
    </WearPriceProfileCountDto>
  </WearPriceProfiles>
</FindAvailableFilterResponse>