ConsumerApi

<back to all web services

FindBoundedMapAdMessagesRequest

Consumer
Requires Authentication
Required role:Consumer
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum

# module ConsumerApi


Python FindBoundedMapAdMessagesRequest 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.

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
}