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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	barTypes: 
	[
		{
			count: 0,
			slug: String,
			title: String
		}
	],
	barSpecialities: 
	[
		{
			count: 0,
			slug: String,
			title: String
		}
	],
	brands: 
	[
		{
			count: 0,
			name: String
		}
	],
	cuisines: 
	[
		{
			count: 0,
			label: String,
			slug: String
		}
	],
	mealType: 
	[
		{
			count: 0,
			label: String,
			slug: String
		}
	],
	eatingSuitabilities: 
	[
		{
			count: 0,
			label: String,
			slug: String
		}
	],
	parkings: 
	[
		{
			count: 0,
			label: String,
			slug: StreetParking
		}
	],
	paymentOptions: 
	[
		{
			count: 0,
			label: String,
			slug: Visa
		}
	],
	priceMainDishes: 
	[
		{
			count: 0,
			title: String,
			slug: Value
		}
	],
	takeAways: 
	[
		{
			count: 0,
			label: String,
			slug: String
		}
	],
	wearPriceProfiles: 
	[
		{
			count: 0,
			slug: String,
			label: String
		}
	],
	categories: 
	[
		{
			name: String,
			slug: String,
			absoluteSlug: String,
			featureTypes: 
			[
				BarSpeciality
			],
			type: Parent,
			count: 0,
			imageUrl: String,
			allImageUrl: String,
			iconImageUrl: String,
			position: 0,
			children: 
			[
				{
					name: String,
					slug: String,
					absoluteSlug: String,
					featureTypes: 
					[
						BarSpeciality
					],
					type: Parent,
					count: 0,
					imageUrl: String,
					allImageUrl: String,
					iconImageUrl: String,
					position: 0,
					children: 
					[
						{
							name: String,
							slug: String,
							absoluteSlug: String,
							featureTypes: 
							[
								BarSpeciality
							],
							type: Parent,
							count: 0,
							imageUrl: String,
							allImageUrl: String,
							iconImageUrl: String,
							position: 0
						}
					]
				}
			]
		}
	]
}