BusinessApi

GetAdMessagesRequest

Business

**Requires Authentication**
Required role:	Business

The following routes are available for this service:
GET	/admessage/get_all

**GetAdMessagesRequest** Parameters:
Name	Parameter	Data Type	Required
PlaceId	query	long	No
VisibilityState	query	VisibilityState	No
Period	query	GetAdMessagesPeriod?	No

**VisibilityState** Enum:
Draft
Running
Upcoming
Archived
Paused

**GetAdMessagesPeriod** Enum:
PastMonth
Past3Months
Past6Months
PastYear

**GetAdMessagesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
AdMessagesWithVisibilityState	form	List<BusinessAdMessageDto>	Yes

**BusinessAdMessageDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Guid	form	Guid	No
Title	form	string	Yes
StartAt	form	PlaceRelativeDateTimeDto	Yes
StopAt	form	PlaceRelativeDateTimeDto	Yes
PublishAt	form	PlaceRelativeDateTimeDto	Yes
State	form	string	Yes
UpdatedAt	form	DateTimeOffset	No
ImageUrls	form	List<ImageUrls>	No
Place	form	PlaceBasicDto	No
DetailsUnion	form	AdMessageDetailsUnion	Yes

**PlaceRelativeDateTimeDto** Parameters:
Name	Parameter	Data Type	Required
Year	form	int	No
Month	form	int	No
Day	form	int	No
Hour	form	int	No
Minute	form	int	No
Second	form	int	No

**ImageUrls** Parameters:
Name	Parameter	Data Type	Required
Preview	form	string	Yes
Small	form	string	Yes
Medium	form	string	Yes
Large	form	string	Yes

**PlaceBasicDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Guid	form	Guid	No
Name	form	string	Yes
BusinessId	form	long?	No
Longitude	form	float?	No
Latitude	form	float?	No
Claimed	form	bool	No
OrganizationNumber	form	string	No
CountryCode	form	string	Yes
Overview	form	string	No
OpeningHours	form	OpeningHours	No
PlaceType	form	PlaceType	No
Contact	form	PlaceContact	Yes
Address	form	PlaceAddress	Yes
WheelChairAccessible	form	bool?	No
Wifi	form	bool?	No
OutdoorSeating	form	bool?	No
SaveFoodAndMoney	form	bool?	No
TimeZoneDto	form	TimeZoneDto	Yes
PriceMainDish	form	PriceMainDishDto	No
OtherServices	form	List<MallOtherServiceDto>	No
Floor	form	string	No

**OpeningHours** Parameters:
Name	Parameter	Data Type	Required	Description
Weekly	form	WeeklyOpeningHours	Yes

**WeeklyOpeningHours** Parameters:
Name	Parameter	Data Type	Required
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

**OpeningHour** Parameters:
Name	Parameter	Data Type	Required
OpenAtHour	form	int	No
OpenAtMinute	form	int	No
CloseAtHour	form	int	No
CloseAtMinute	form	int	No

**PlaceType** Enum:
Mall
Regular

**PlaceContact** Parameters:
Name	Parameter	Data Type	Required
Phone	form	string	No
Email	form	string	No
Website	form	string	No
WebShop	form	string	No

**PlaceAddress** Parameters:
Name	Parameter	Data Type	Required
Street	form	string	Yes
PostalCode	form	string	Yes
Region	form	string	Yes
CountryCode	form	string	Yes

**TimeZoneDto** Parameters:
Name	Parameter	Data Type	Required
BaseUtcOffset	form	TimeSpan	No
DaylightName	form	string	Yes
DisplayName	form	string	Yes
Id	form	string	Yes
StandardName	form	string	Yes
SupportsDaylightSavingTime	form	bool	No

**PriceMainDishDto** Parameters:
Name	Parameter	Data Type	Required	Description
Title	form	string	Yes
Slug	form	PriceMainDish	No

**PriceMainDish** Enum:
Value
Medium
High
FineDining

**MallOtherServiceDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
ServiceName	form	string	Yes
Floor	form	string	Yes

**AdMessageDetailsUnion** Parameters:
Name	Parameter	Data Type	Required
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

**AdMessageDetailsPercentageDiscountOnAllMerchandise** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsBase** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	No
MoreInformation	form	List<string>	No

**AdMessageDetailsPercentageDiscountRangeOnAllMerchandise** Parameters:
Name	Parameter	Data Type	Required	Description
Start	form	double	No
Stop	form	double	No

**AdMessageDetailsPercentageDiscountOnSelectedMerchandise** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise** Parameters:
Name	Parameter	Data Type	Required	Description
Start	form	double	No
Stop	form	double	No

**AdMessageDetailsTotalAmountOverXgivesYdiscount** Parameters:
Name	Parameter	Data Type	Required	Description
IfTotalAmountMoreThanX	form	double	No
ThenYouGetDiscountPercentageY	form	double	No

**AdMessageDetailsXforYdiscount** Parameters:
Name	Parameter	Data Type	Required	Description
IfYouBuyX	form	int	No
ThenYouGetY	form	int	No

**AdMessageDetailsFreetext** Parameters:
Name	Parameter	Data Type	Required	Description
Title	form	string	Yes

**AdMessageDetailsTodaysBreakFastOffer** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsTodaysLunchOffer** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsTodaysDinnerOffer** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsSaveFoodAndMoney** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsPercentageOffYourFoodBill** Parameters:
Name	Parameter	Data Type	Required	Description
Percentage	form	double	No

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 /admessage/get_all HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	adMessagesWithVisibilityState: 
	[
		{
			id: 0,
			title: String,
			startAt: 
			{
				year: 0,
				month: 0,
				day: 0,
				hour: 0,
				minute: 0,
				second: 0
			},
			stopAt: 
			{
				year: 0,
				month: 0,
				day: 0,
				hour: 0,
				minute: 0,
				second: 0
			},
			publishAt: 
			{
				year: 0,
				month: 0,
				day: 0,
				hour: 0,
				minute: 0,
				second: 0
			},
			state: String,
			updatedAt: 0001-01-01T00:00:00.0000000+00:00,
			imageUrls: 
			[
				{
					preview: String,
					small: String,
					medium: String,
					large: String
				}
			],
			place: 
			{
				id: 0,
				name: String,
				businessId: 0,
				longitude: 0,
				latitude: 0,
				claimed: False,
				organizationNumber: String,
				countryCode: String,
				overview: 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
						}
					}
				},
				placeType: Mall,
				contact: 
				{
					phone: String,
					email: String,
					website: String,
					webShop: String
				},
				address: 
				{
					street: String,
					postalCode: String,
					region: String,
					countryCode: String
				},
				wheelChairAccessible: False,
				wifi: False,
				outdoorSeating: False,
				saveFoodAndMoney: False,
				timeZoneDto: 
				{
					baseUtcOffset: PT0S,
					daylightName: String,
					displayName: String,
					id: String,
					standardName: String,
					supportsDaylightSavingTime: False
				},
				priceMainDish: 
				{
					title: String,
					slug: Value
				},
				otherServices: 
				[
					{
						id: 0,
						serviceName: String,
						floor: 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
					]
				}
			}
		}
	]
}