ConsumerApi

<back to all web services

AddSavedSearchRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
POST/searches/AddSavedSearch
AddSavedSearchRequest Parameters:
NameParameterData TypeRequiredDescription
NamebodystringYes
FilterbodyQueryFilterDtoYes
LocationbodyQueryLocationDtoYes
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
AddSavedSearchResponse Parameters:
NameParameterData TypeRequiredDescription
SavedSearchIdformlongNo

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.

POST /searches/AddSavedSearch HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	savedSearchId: 0
}