Required role: | Consumer |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CacheVersion | query | long? | No | |
Filter | query | QueryFilterDto | No | |
Bounds | query | MapBoundsDto | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Term | form | string | No | |
PlaceGuid | form | Guid? | No | |
AdMessageGuid | form | Guid? | No | |
CategoryAbsoluteSlugs | form | List<string> | No | |
BarSpecialitySlugs | form | List<string> | No | |
BarTypeSlugs | form | List<string> | No | |
BrandNames | form | List<string> | No | |
CuisineSlugs | form | List<string> | No | |
MealTypeSlugs | form | List<string> | No | |
Parking | form | List<Parking> | No | |
PaymentOptions | form | List<PaymentOption> | No | |
PriceMainDishes | form | List<PriceMainDish> | No | |
EatingSuitabilitySlugs | form | List<string> | No | |
TakeAwaySlugs | form | List<string> | No | |
WearPriceProfileSlugs | form | List<string> | No | |
WheelChairAccessible | form | bool? | No | |
Wifi | form | bool? | No | |
OutdoorSeating | form | bool? | No | |
SaveFoodAndMoney | form | bool? | No | |
OpenAt | form | OpenAtTimeDto | No |
StreetParking | |
ParkingGarageNearby |
Visa | |
MasterCard | |
AmericanExpress | |
Diners | |
Vipps |
Value | |
Medium | |
High | |
FineDining |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
WeekDay | form | DayOfWeek | No | |
Hour | form | int | No | |
Minute | form | int | No |
Sunday | |
Monday | |
Tuesday | |
Wednesday | |
Thursday | |
Friday | |
Saturday |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
North | form | float? | No | |
South | form | float? | No | |
East | form | float? | No | |
West | form | float? | No | |
ClusterZoomLevel | form | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Clusters | form | List<FindBoundedMapPinCluster> | Yes | |
AdMessagesWithDisplayLocation | form | List<AdMessageWithDisplayLocationDto> | Yes | |
CategoryFacetTrees | form | List<CategoryFacetTreeDto> | Yes | |
PlaceCount | form | long | No | |
AdMessageSaveFoodAndMoneyCount | form | long? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Count | form | long | No | |
Latitude | form | float | No | |
Longitude | form | float | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AdMessage | form | AdMessageDto | Yes | |
CrowdedMapDisplayLocation | form | Position | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
Guid | form | Guid | No | |
Title | form | string | Yes | |
StartAt | form | DateTimeOffset | No | |
StopAt | form | DateTimeOffset | No | |
PublishAt | form | DateTimeOffset | No | |
ImageUrls | form | List<ImageUrls> | Yes | |
Place | form | PlaceBasicDto | Yes | |
DetailsUnion | form | AdMessageDetailsUnion | Yes | |
StarredCount | form | long | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Preview | form | string | Yes | |
Small | form | string | Yes | |
Medium | form | string | Yes | |
Large | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
Guid | form | Guid | No | |
Overview | form | string | No | |
Name | form | string | Yes | |
Longitude | form | float | No | |
Latitude | form | float | No | |
Claimed | form | bool | No | |
OrganizationNumber | form | string | No | |
CountryCode | form | string | Yes | |
OpeningHours | form | OpeningHours | No | |
WheelchairAccessible | form | bool? | No | |
Wifi | form | bool? | No | |
OutdoorSeating | form | bool? | No | |
SaveFoodAndMoney | form | bool? | No | |
PlaceType | form | PlaceType | No | |
PriceMainDish | form | PriceMainDishDto | No | |
TimeZoneDto | form | TimeZoneDto | Yes | |
BusinessId | form | long? | No | |
Contact | form | PlaceContact | Yes | |
Address | form | PlaceAddress | Yes | |
Categories | form | List<CategoryTreeDto> | Yes | |
LogoUrl | form | ImageUrls | No | |
ImageUrl | form | ImageUrls | No | |
WearPriceProfiles | form | List<WearPriceProfileDto> | Yes | |
Brands | form | List<PlaceSelectedBrandDto> | Yes | |
Floor | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Weekly | form | WeeklyOpeningHours | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Monday | form | OpeningHour | No | |
Tuesday | form | OpeningHour | No | |
Wednesday | form | OpeningHour | No | |
Thursday | form | OpeningHour | No | |
Friday | form | OpeningHour | No | |
Saturday | form | OpeningHour | No | |
Sunday | form | OpeningHour | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OpenAtHour | form | int | No | |
OpenAtMinute | form | int | No | |
CloseAtHour | form | int | No | |
CloseAtMinute | form | int | No |
Mall | |
Regular |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Title | form | string | Yes | |
Slug | form | PriceMainDish | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BaseUtcOffset | form | TimeSpan | No | |
DaylightName | form | string | Yes | |
DisplayName | form | string | Yes | |
Id | form | string | Yes | |
StandardName | form | string | Yes | |
SupportsDaylightSavingTime | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Phone | form | string | No | |
form | string | No | ||
Website | form | string | No | |
WebShop | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Street | form | string | Yes | |
PostalCode | form | string | Yes | |
Region | form | string | Yes | |
CountryCode | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Slug | form | string | Yes | |
AbsoluteSlug | form | string | Yes | |
ImageUrl | form | string | No | |
AllImageUrl | form | string | No | |
IconImageUrl | form | string | No | |
Position | form | int | No | |
Children | form | List<CategoryTreeDto> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Slug | form | string | Yes | |
Label | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Brand | form | BrandDto | No | |
CategoryAbsoluteSlugs | form | string[] | No | |
PlaceCustomBrand | form | PlaceCustomBrandDto | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PercentageOnAllMerchandise | form | AdMessageDetailsPercentageDiscountOnAllMerchandise | No | |
PercentageRangeOnAllMerchandise | form | AdMessageDetailsPercentageDiscountRangeOnAllMerchandise | No | |
PercentageOnSelectedMerchandise | form | AdMessageDetailsPercentageDiscountOnSelectedMerchandise | No | |
AbsoluteOnSelectedMerchandise | form | AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise | No | |
AbsoluteRangeOnAllMerchandise | form | AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise | No | |
TotalAmountOverXgivesYdiscount | form | AdMessageDetailsTotalAmountOverXgivesYdiscount | No | |
XforY | form | AdMessageDetailsXforYdiscount | No | |
NewArrivals | form | AdMessageDetailsNewArrivals | No | |
Freetext | form | AdMessageDetailsFreetext | No | |
TodaysBreakFastOffer | form | AdMessageDetailsTodaysBreakFastOffer | No | |
TodaysLunchOffer | form | AdMessageDetailsTodaysLunchOffer | No | |
TodaysDinnerOffer | form | AdMessageDetailsTodaysDinnerOffer | No | |
SaveFoodAndMoney | form | AdMessageDetailsSaveFoodAndMoney | No | |
PercentageOfYourFoodBill | form | AdMessageDetailsPercentageOffYourFoodBill | No | |
HappyHour | form | AdMessageDetailsHappyHour | No | |
SomeFreeTablesLeftToday | form | AdMessageDetailsSomeFreeTablesLeftToday | No | |
TwoDishesForThePriceOfOne | form | AdMessageDetailsTwoDishesForThePriceOfOne | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Description | form | string | No | |
MoreInformation | form | List<string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Start | form | double | No | |
Stop | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Start | form | double | No | |
Stop | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IfTotalAmountMoreThanX | form | double | No | |
ThenYouGetDiscountPercentageY | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IfYouBuyX | form | int | No | |
ThenYouGetY | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Title | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Percentage | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Longitude | form | float | No | |
Latitude | form | float | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Slug | form | string | Yes | |
AbsoluteSlug | form | string | Yes | |
FeatureTypes | form | List<FeatureType> | No | |
Type | form | CategoryFacetTreeType | No | |
Count | form | long? | No | |
ImageUrl | form | string | No | |
AllImageUrl | form | string | No | |
IconImageUrl | form | string | No | |
Position | form | int | No | |
Children | form | List<CategoryFacetTreeDto> | No |
BarSpeciality | |
BarType | |
Cuisine | |
SaveFoodAndMoney | |
MealType | |
Menu | |
OutdoorSeating | |
Parking | |
PaymentOptions | |
PriceMainDish | |
SubCategories | |
SubCategoriesAndBrands | |
EatingSuitabilities | |
TakeAway | |
WearPriceProfile | |
WheelChairAccessible | |
Wifi | |
WebShop | |
Filtering |
Parent | |
Selected | |
Available |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/FindBoundedMapAdMessagesRequest HTTP/1.1
Host: consumer-api.brovs.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
cacheVersion: 0,
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
}
},
bounds:
{
north: 0,
south: 0,
east: 0,
west: 0,
clusterZoomLevel: 0
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { clusters: [ { count: 0, latitude: 0, longitude: 0 } ], adMessagesWithDisplayLocation: [ { adMessage: { id: 0, title: String, startAt: 0001-01-01T00:00:00.0000000+00:00, stopAt: 0001-01-01T00:00:00.0000000+00:00, publishAt: 0001-01-01T00:00:00.0000000+00:00, imageUrls: [ { preview: String, small: String, medium: String, large: String } ], place: { id: 0, overview: String, name: String, longitude: 0, latitude: 0, claimed: False, organizationNumber: String, countryCode: String, openingHours: { weekly: { monday: { openAtHour: 0, openAtMinute: 0, closeAtHour: 0, closeAtMinute: 0 }, tuesday: { openAtHour: 0, openAtMinute: 0, closeAtHour: 0, closeAtMinute: 0 }, wednesday: { openAtHour: 0, openAtMinute: 0, closeAtHour: 0, closeAtMinute: 0 }, thursday: { openAtHour: 0, openAtMinute: 0, closeAtHour: 0, closeAtMinute: 0 }, friday: { openAtHour: 0, openAtMinute: 0, closeAtHour: 0, closeAtMinute: 0 }, saturday: { openAtHour: 0, openAtMinute: 0, closeAtHour: 0, closeAtMinute: 0 }, sunday: { openAtHour: 0, openAtMinute: 0, closeAtHour: 0, closeAtMinute: 0 } } }, wheelchairAccessible: False, wifi: False, outdoorSeating: False, saveFoodAndMoney: False, placeType: Mall, priceMainDish: { title: String, slug: Value }, timeZoneDto: { baseUtcOffset: PT0S, daylightName: String, displayName: String, id: String, standardName: String, supportsDaylightSavingTime: False }, businessId: 0, contact: { phone: String, email: String, website: String, webShop: String }, address: { street: String, postalCode: String, region: String, countryCode: String }, categories: [ { name: String, slug: String, absoluteSlug: String, imageUrl: String, allImageUrl: String, iconImageUrl: String, position: 0, children: [ { name: String, slug: String, absoluteSlug: String, imageUrl: String, allImageUrl: String, iconImageUrl: String, position: 0, children: [ { name: String, slug: String, absoluteSlug: String, imageUrl: String, allImageUrl: String, iconImageUrl: String, position: 0 } ] } ] } ], logoUrl: { preview: String, small: String, medium: String, large: String }, imageUrl: { preview: String, small: String, medium: String, large: String }, wearPriceProfiles: [ { slug: String, label: String } ], brands: [ { brand: { name: String }, categoryAbsoluteSlugs: [ String ], placeCustomBrand: { name: String } } ], floor: String }, detailsUnion: { percentageOnAllMerchandise: { value: 0, description: String, moreInformation: [ String ] }, percentageRangeOnAllMerchandise: { start: 0, stop: 0, description: String, moreInformation: [ String ] }, percentageOnSelectedMerchandise: { value: 0, description: String, moreInformation: [ String ] }, absoluteOnSelectedMerchandise: { value: 0, description: String, moreInformation: [ String ] }, absoluteRangeOnAllMerchandise: { start: 0, stop: 0, description: String, moreInformation: [ String ] }, totalAmountOverXgivesYdiscount: { ifTotalAmountMoreThanX: 0, thenYouGetDiscountPercentageY: 0, description: String, moreInformation: [ String ] }, xforY: { ifYouBuyX: 0, thenYouGetY: 0, description: String, moreInformation: [ String ] }, newArrivals: { description: String, moreInformation: [ String ] }, freetext: { title: String, description: String, moreInformation: [ String ] }, todaysBreakFastOffer: { value: 0, description: String, moreInformation: [ String ] }, todaysLunchOffer: { value: 0, description: String, moreInformation: [ String ] }, todaysDinnerOffer: { value: 0, description: String, moreInformation: [ String ] }, saveFoodAndMoney: { value: 0, description: String, moreInformation: [ String ] }, percentageOfYourFoodBill: { percentage: 0, description: String, moreInformation: [ String ] }, happyHour: { description: String, moreInformation: [ String ] }, someFreeTablesLeftToday: { description: String, moreInformation: [ String ] }, twoDishesForThePriceOfOne: { description: String, moreInformation: [ String ] } }, starredCount: 0 }, crowdedMapDisplayLocation: { longitude: 0, latitude: 0 } } ], categoryFacetTrees: [ { 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 } ] } ] } ], placeCount: 0, adMessageSaveFoodAndMoneyCount: 0 }