ConsumerApi

<back to all web services

GetSavedSearchesRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/searches/GetSavedSearches
GetSavedSearchesResponse Parameters:
NameParameterData TypeRequiredDescription
SearchesformList<SavedSearchDto>Yes
SavedSearchDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringYes
FilterformQueryFilterDtoYes
LocationformQueryLocationDtoYes
FilterDetailsformFilterDetailsYes
CreatedAtformDateTimeOffsetNo
UpdatedAtformDateTimeOffsetNo
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
FilterDetails Parameters:
NameParameterData TypeRequiredDescription
CategoriesformList<CategoryDto>Yes
BarSpecialitiesformList<BarSpecialityDto>Yes
BarTypesformList<BarTypeDto>Yes
BrandsformList<BrandDto>Yes
CuisinesformList<CuisineDto>Yes
MealTypesformList<MealTypeDto>Yes
ParkingformList<ParkingDto>Yes
PaymentOptionsformList<PaymentOptionDto>Yes
PriceMainDishesformList<PriceMainDishDto>Yes
EatingSuitabilityformList<EatingSuitabilityDto>Yes
TakeAwaysformList<TakeAwayDto>Yes
WearPriceProfilesformList<WearPriceProfileDto>Yes
RootCategoriesformList<CategoryDto>Yes
CategoryDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
SlugformstringYes
AbsoluteSlugformstringYes
ImageUrlformstringNo
AllImageUrlformstringNo
IconImageUrlformstringNo
PositionformintNo
BarSpecialityDto Parameters:
NameParameterData TypeRequiredDescription
SlugformstringYes
TitleformstringYes
BarTypeDto Parameters:
NameParameterData TypeRequiredDescription
SlugformstringYes
TitleformstringYes
BrandDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
CuisineDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformstringYes
MealTypeDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformstringYes
ParkingDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformParkingNo
PaymentOptionDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformPaymentOptionNo
PriceMainDishDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes
SlugformPriceMainDishNo
EatingSuitabilityDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformstringYes
TakeAwayDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformstringYes
WearPriceProfileDto Parameters:
NameParameterData TypeRequiredDescription
SlugformstringYes
LabelformstringYes

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 /searches/GetSavedSearches HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	searches: 
	[
		{
			id: 0,
			name: String,
			filter: 
			{
				term: String,
				placeGuid: 00000000-0000-0000-0000-000000000000,
				adMessageGuid: 00000000-0000-0000-0000-000000000000,
				categoryAbsoluteSlugs: 
				[
					String
				],
				barSpecialitySlugs: 
				[
					String
				],
				barTypeSlugs: 
				[
					String
				],
				brandNames: 
				[
					String
				],
				cuisineSlugs: 
				[
					String
				],
				mealTypeSlugs: 
				[
					String
				],
				parking: 
				[
					StreetParking
				],
				paymentOptions: 
				[
					Visa
				],
				priceMainDishes: 
				[
					Value
				],
				eatingSuitabilitySlugs: 
				[
					String
				],
				takeAwaySlugs: 
				[
					String
				],
				wearPriceProfileSlugs: 
				[
					String
				],
				wheelChairAccessible: False,
				wifi: False,
				outdoorSeating: False,
				saveFoodAndMoney: False,
				openAt: 
				{
					weekDay: Sunday,
					hour: 0,
					minute: 0
				}
			},
			location: 
			{
				longitude: 0,
				latitude: 0,
				searchRadiusInKm: 0
			},
			filterDetails: 
			{
				categories: 
				[
					{
						name: String,
						slug: String,
						absoluteSlug: String,
						imageUrl: String,
						allImageUrl: String,
						iconImageUrl: String,
						position: 0
					}
				],
				barSpecialities: 
				[
					{
						slug: String,
						title: String
					}
				],
				barTypes: 
				[
					{
						slug: String,
						title: String
					}
				],
				brands: 
				[
					{
						name: String
					}
				],
				cuisines: 
				[
					{
						label: String,
						slug: String
					}
				],
				mealTypes: 
				[
					{
						label: String,
						slug: String
					}
				],
				parking: 
				[
					{
						label: String,
						slug: StreetParking
					}
				],
				paymentOptions: 
				[
					{
						label: String,
						slug: Visa
					}
				],
				priceMainDishes: 
				[
					{
						title: String,
						slug: Value
					}
				],
				eatingSuitability: 
				[
					{
						label: String,
						slug: String
					}
				],
				takeAways: 
				[
					{
						label: String,
						slug: String
					}
				],
				wearPriceProfiles: 
				[
					{
						slug: String,
						label: String
					}
				],
				rootCategories: 
				[
					{
						name: String,
						slug: String,
						absoluteSlug: String,
						imageUrl: String,
						allImageUrl: String,
						iconImageUrl: String,
						position: 0
					}
				]
			},
			createdAt: 0001-01-01T00:00:00.0000000+00:00,
			updatedAt: 0001-01-01T00:00:00.0000000+00:00
		}
	]
}