ConsumerApi

<back to all web services

FindAvailableFilterRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/find/filtering
"use strict";
/** @typedef {'StreetParking'|'ParkingGarageNearby'} */
export var Parking;
(function (Parking) {
    Parking["StreetParking"] = "StreetParking"
    Parking["ParkingGarageNearby"] = "ParkingGarageNearby"
})(Parking || (Parking = {}));
/** @typedef {'Visa'|'MasterCard'|'AmericanExpress'|'Diners'|'Vipps'} */
export var PaymentOption;
(function (PaymentOption) {
    PaymentOption["Visa"] = "Visa"
    PaymentOption["MasterCard"] = "MasterCard"
    PaymentOption["AmericanExpress"] = "AmericanExpress"
    PaymentOption["Diners"] = "Diners"
    PaymentOption["Vipps"] = "Vipps"
})(PaymentOption || (PaymentOption = {}));
/** @typedef {'Value'|'Medium'|'High'|'FineDining'} */
export var PriceMainDish;
(function (PriceMainDish) {
    PriceMainDish["Value"] = "Value"
    PriceMainDish["Medium"] = "Medium"
    PriceMainDish["High"] = "High"
    PriceMainDish["FineDining"] = "FineDining"
})(PriceMainDish || (PriceMainDish = {}));
/** @typedef {'Sunday'|'Monday'|'Tuesday'|'Wednesday'|'Thursday'|'Friday'|'Saturday'} */
export var DayOfWeek;
(function (DayOfWeek) {
    DayOfWeek["Sunday"] = "Sunday"
    DayOfWeek["Monday"] = "Monday"
    DayOfWeek["Tuesday"] = "Tuesday"
    DayOfWeek["Wednesday"] = "Wednesday"
    DayOfWeek["Thursday"] = "Thursday"
    DayOfWeek["Friday"] = "Friday"
    DayOfWeek["Saturday"] = "Saturday"
})(DayOfWeek || (DayOfWeek = {}));
export class OpenAtTimeDto {
    /** @param {{weekDay?:DayOfWeek,hour?:number,minute?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?DayOfWeek} */
    weekDay;
    /** @type {?number} */
    hour;
    /** @type {?number} */
    minute;
}
export class BarTypeEsDto {
    /** @param {{slug?:string,title?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    slug;
    /** @type {string} */
    title;
}
export class BarSpecialityEsDto {
    /** @param {{slug?:string,title?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    slug;
    /** @type {string} */
    title;
}
export class BrandApiDto {
    /** @param {{name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    name;
}
export class CuisineEsDto {
    /** @param {{label?:string,slug?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    label;
    /** @type {string} */
    slug;
}
export class MealTypeApiDto {
    /** @param {{label?:string,slug?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    label;
    /** @type {string} */
    slug;
}
export class EatingSuitabilityApiDto {
    /** @param {{label?:string,slug?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    label;
    /** @type {string} */
    slug;
}
export class ParkingApiDto {
    /** @param {{label?:string,slug?:Parking}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    label;
    /** @type {?Parking} */
    slug;
}
export class PaymentOptionApiDto {
    /** @param {{label?:string,slug?:PaymentOption}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    label;
    /** @type {?PaymentOption} */
    slug;
}
export class PriceMainDishApiDto {
    /** @param {{title?:string,slug?:PriceMainDish}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    title;
    /** @type {?PriceMainDish} */
    slug;
}
export class TakeAwayApiDto {
    /** @param {{label?:string,slug?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    label;
    /** @type {string} */
    slug;
}
export class WearPriceProfileEsDto {
    /** @param {{slug?:string,label?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    slug;
    /** @type {string} */
    label;
}
/** @typedef {'BarSpeciality'|'BarType'|'Cuisine'|'SaveFoodAndMoney'|'MealType'|'Menu'|'OutdoorSeating'|'Parking'|'PaymentOptions'|'PriceMainDish'|'SubCategories'|'SubCategoriesAndBrands'|'EatingSuitabilities'|'TakeAway'|'WearPriceProfile'|'WheelChairAccessible'|'Wifi'|'WebShop'|'Filtering'} */
export var FeatureType;
(function (FeatureType) {
    FeatureType["BarSpeciality"] = "BarSpeciality"
    FeatureType["BarType"] = "BarType"
    FeatureType["Cuisine"] = "Cuisine"
    FeatureType["SaveFoodAndMoney"] = "SaveFoodAndMoney"
    FeatureType["MealType"] = "MealType"
    FeatureType["Menu"] = "Menu"
    FeatureType["OutdoorSeating"] = "OutdoorSeating"
    FeatureType["Parking"] = "Parking"
    FeatureType["PaymentOptions"] = "PaymentOptions"
    FeatureType["PriceMainDish"] = "PriceMainDish"
    FeatureType["SubCategories"] = "SubCategories"
    FeatureType["SubCategoriesAndBrands"] = "SubCategoriesAndBrands"
    FeatureType["EatingSuitabilities"] = "EatingSuitabilities"
    FeatureType["TakeAway"] = "TakeAway"
    FeatureType["WearPriceProfile"] = "WearPriceProfile"
    FeatureType["WheelChairAccessible"] = "WheelChairAccessible"
    FeatureType["Wifi"] = "Wifi"
    FeatureType["WebShop"] = "WebShop"
    FeatureType["Filtering"] = "Filtering"
})(FeatureType || (FeatureType = {}));

JavaScript FindAvailableFilterRequest DTOs

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: unstable-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
						}
					]
				}
			]
		}
	]
}