ConsumerApi

<back to all web services

GetAdMessageDraftsRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/admessage/drafts
GetAdMessageDraftsResponse Parameters:
NameParameterData TypeRequiredDescription
DraftAdMessagesformList<AdMessageDto>Yes
AdMessageDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
GuidformGuidNo
TitleformstringYes
StartAtformDateTimeOffsetNo
StopAtformDateTimeOffsetNo
PublishAtformDateTimeOffsetNo
ImageUrlsformList<ImageUrls>Yes
PlaceformPlaceBasicDtoYes
DetailsUnionformAdMessageDetailsUnionYes
StarredCountformlongNo
ImageUrls Parameters:
NameParameterData TypeRequiredDescription
PreviewformstringYes
SmallformstringYes
MediumformstringYes
LargeformstringYes
PlaceBasicDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
GuidformGuidNo
OverviewformstringNo
NameformstringYes
LongitudeformfloatNo
LatitudeformfloatNo
ClaimedformboolNo
OrganizationNumberformstringNo
CountryCodeformstringYes
OpeningHoursformOpeningHoursNo
WheelchairAccessibleformbool?No
Wififormbool?No
OutdoorSeatingformbool?No
SaveFoodAndMoneyformbool?No
PlaceTypeformPlaceTypeNo
PriceMainDishformPriceMainDishDtoNo
TimeZoneDtoformTimeZoneDtoYes
BusinessIdformlong?No
ContactformPlaceContactYes
AddressformPlaceAddressYes
CategoriesformList<CategoryTreeDto>Yes
LogoUrlformImageUrlsNo
ImageUrlformImageUrlsNo
WearPriceProfilesformList<WearPriceProfileDto>Yes
BrandsformList<PlaceSelectedBrandDto>Yes
FloorformstringNo
OpeningHours Parameters:
NameParameterData TypeRequiredDescription
WeeklyformWeeklyOpeningHoursYes
WeeklyOpeningHours Parameters:
NameParameterData TypeRequiredDescription
MondayformOpeningHourNo
TuesdayformOpeningHourNo
WednesdayformOpeningHourNo
ThursdayformOpeningHourNo
FridayformOpeningHourNo
SaturdayformOpeningHourNo
SundayformOpeningHourNo
OpeningHour Parameters:
NameParameterData TypeRequiredDescription
OpenAtHourformintNo
OpenAtMinuteformintNo
CloseAtHourformintNo
CloseAtMinuteformintNo
PlaceType Enum:
Mall
Regular
PriceMainDishDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes
SlugformPriceMainDishNo
PriceMainDish Enum:
Value
Medium
High
FineDining
TimeZoneDto Parameters:
NameParameterData TypeRequiredDescription
BaseUtcOffsetformTimeSpanNo
DaylightNameformstringYes
DisplayNameformstringYes
IdformstringYes
StandardNameformstringYes
SupportsDaylightSavingTimeformboolNo
PlaceContact Parameters:
NameParameterData TypeRequiredDescription
PhoneformstringNo
EmailformstringNo
WebsiteformstringNo
WebShopformstringNo
PlaceAddress Parameters:
NameParameterData TypeRequiredDescription
StreetformstringYes
PostalCodeformstringYes
RegionformstringYes
CountryCodeformstringYes
CategoryTreeDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
SlugformstringYes
AbsoluteSlugformstringYes
ImageUrlformstringNo
AllImageUrlformstringNo
IconImageUrlformstringNo
PositionformintNo
ChildrenformList<CategoryTreeDto>No
WearPriceProfileDto Parameters:
NameParameterData TypeRequiredDescription
SlugformstringYes
LabelformstringYes
PlaceSelectedBrandDto Parameters:
NameParameterData TypeRequiredDescription
BrandformBrandDtoNo
CategoryAbsoluteSlugsformstring[]No
PlaceCustomBrandformPlaceCustomBrandDtoNo
BrandDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
PlaceCustomBrandDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
AdMessageDetailsUnion Parameters:
NameParameterData TypeRequiredDescription
PercentageOnAllMerchandiseformAdMessageDetailsPercentageDiscountOnAllMerchandiseNo
PercentageRangeOnAllMerchandiseformAdMessageDetailsPercentageDiscountRangeOnAllMerchandiseNo
PercentageOnSelectedMerchandiseformAdMessageDetailsPercentageDiscountOnSelectedMerchandiseNo
AbsoluteOnSelectedMerchandiseformAdMessageDetailsAbsoluteDiscountOnSelectedMerchandiseNo
AbsoluteRangeOnAllMerchandiseformAdMessageDetailsAbsoluteDiscountRangeOnAllMerchandiseNo
TotalAmountOverXgivesYdiscountformAdMessageDetailsTotalAmountOverXgivesYdiscountNo
XforYformAdMessageDetailsXforYdiscountNo
NewArrivalsformAdMessageDetailsNewArrivalsNo
FreetextformAdMessageDetailsFreetextNo
TodaysBreakFastOfferformAdMessageDetailsTodaysBreakFastOfferNo
TodaysLunchOfferformAdMessageDetailsTodaysLunchOfferNo
TodaysDinnerOfferformAdMessageDetailsTodaysDinnerOfferNo
SaveFoodAndMoneyformAdMessageDetailsSaveFoodAndMoneyNo
PercentageOfYourFoodBillformAdMessageDetailsPercentageOffYourFoodBillNo
HappyHourformAdMessageDetailsHappyHourNo
SomeFreeTablesLeftTodayformAdMessageDetailsSomeFreeTablesLeftTodayNo
TwoDishesForThePriceOfOneformAdMessageDetailsTwoDishesForThePriceOfOneNo
AdMessageDetailsPercentageDiscountOnAllMerchandise Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsBase Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
MoreInformationformList<string>No
AdMessageDetailsPercentageDiscountRangeOnAllMerchandise Parameters:
NameParameterData TypeRequiredDescription
StartformdoubleNo
StopformdoubleNo
AdMessageDetailsPercentageDiscountOnSelectedMerchandise Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise Parameters:
NameParameterData TypeRequiredDescription
StartformdoubleNo
StopformdoubleNo
AdMessageDetailsTotalAmountOverXgivesYdiscount Parameters:
NameParameterData TypeRequiredDescription
IfTotalAmountMoreThanXformdoubleNo
ThenYouGetDiscountPercentageYformdoubleNo
AdMessageDetailsXforYdiscount Parameters:
NameParameterData TypeRequiredDescription
IfYouBuyXformintNo
ThenYouGetYformintNo
AdMessageDetailsFreetext Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes
AdMessageDetailsTodaysBreakFastOffer Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsTodaysLunchOffer Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsTodaysDinnerOffer Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsSaveFoodAndMoney Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsPercentageOffYourFoodBill Parameters:
NameParameterData TypeRequiredDescription
PercentageformdoubleNo

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

{
	draftAdMessages: 
	[
		{
			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
		}
	]
}