Required role: | Consumer |
GET | /admessage/{AdMessageGuid} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AdMessageGuid | path | Guid | No | |
CacheVersion | query | long? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AdMessageDto | form | AdMessageDto | 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 |
Value | |
Medium | |
High | |
FineDining |
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 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /admessage/{AdMessageGuid} HTTP/1.1 Host: consumer-api.brovs.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GetAdMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto"> <AdMessageDto> <DetailsUnion xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common"> <d3p1:AbsoluteOnSelectedMerchandise> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:Value>0</d3p1:Value> </d3p1:AbsoluteOnSelectedMerchandise> <d3p1:AbsoluteRangeOnAllMerchandise> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:Start>0</d3p1:Start> <d3p1:Stop>0</d3p1:Stop> </d3p1:AbsoluteRangeOnAllMerchandise> <d3p1:Freetext> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:Title>String</d3p1:Title> </d3p1:Freetext> <d3p1:HappyHour> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> </d3p1:HappyHour> <d3p1:NewArrivals> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> </d3p1:NewArrivals> <d3p1:PercentageOfYourFoodBill> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:Percentage>0</d3p1:Percentage> </d3p1:PercentageOfYourFoodBill> <d3p1:PercentageOnAllMerchandise> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:Value>0</d3p1:Value> </d3p1:PercentageOnAllMerchandise> <d3p1:PercentageOnSelectedMerchandise> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:Value>0</d3p1:Value> </d3p1:PercentageOnSelectedMerchandise> <d3p1:PercentageRangeOnAllMerchandise> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:Start>0</d3p1:Start> <d3p1:Stop>0</d3p1:Stop> </d3p1:PercentageRangeOnAllMerchandise> <d3p1:SaveFoodAndMoney> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:Value>0</d3p1:Value> </d3p1:SaveFoodAndMoney> <d3p1:SomeFreeTablesLeftToday> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> </d3p1:SomeFreeTablesLeftToday> <d3p1:TodaysBreakFastOffer> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:Value>0</d3p1:Value> </d3p1:TodaysBreakFastOffer> <d3p1:TodaysDinnerOffer> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:Value>0</d3p1:Value> </d3p1:TodaysDinnerOffer> <d3p1:TodaysLunchOffer> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:Value>0</d3p1:Value> </d3p1:TodaysLunchOffer> <d3p1:TotalAmountOverXgivesYdiscount> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:IfTotalAmountMoreThanX>0</d3p1:IfTotalAmountMoreThanX> <d3p1:ThenYouGetDiscountPercentageY>0</d3p1:ThenYouGetDiscountPercentageY> </d3p1:TotalAmountOverXgivesYdiscount> <d3p1:TwoDishesForThePriceOfOne> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> </d3p1:TwoDishesForThePriceOfOne> <d3p1:XforY> <d3p1:Description>String</d3p1:Description> <d3p1:MoreInformation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>String</d5p1:string> </d3p1:MoreInformation> <d3p1:IfYouBuyX>0</d3p1:IfYouBuyX> <d3p1:ThenYouGetY>0</d3p1:ThenYouGetY> </d3p1:XforY> </DetailsUnion> <Guid>00000000-0000-0000-0000-000000000000</Guid> <Id>0</Id> <ImageUrls xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common"> <d3p1:ImageUrls> <d3p1:Large>String</d3p1:Large> <d3p1:Medium>String</d3p1:Medium> <d3p1:Preview>String</d3p1:Preview> <d3p1:Small>String</d3p1:Small> </d3p1:ImageUrls> </ImageUrls> <Place> <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common"> <d4p1:CountryCode>String</d4p1:CountryCode> <d4p1:PostalCode>String</d4p1:PostalCode> <d4p1:Region>String</d4p1:Region> <d4p1:Street>String</d4p1:Street> </Address> <Brands> <PlaceSelectedBrandDto> <Brand> <Name>String</Name> </Brand> <CategoryAbsoluteSlugs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>String</d6p1:string> </CategoryAbsoluteSlugs> <PlaceCustomBrand> <Name>String</Name> </PlaceCustomBrand> </PlaceSelectedBrandDto> </Brands> <BusinessId>0</BusinessId> <Categories> <CategoryTreeDto> <AbsoluteSlug>String</AbsoluteSlug> <AllImageUrl>String</AllImageUrl> <Children> <CategoryTreeDto> <AbsoluteSlug>String</AbsoluteSlug> <AllImageUrl>String</AllImageUrl> <Children> <CategoryTreeDto> <AbsoluteSlug>String</AbsoluteSlug> <AllImageUrl>String</AllImageUrl> <Children i:nil="true" /> <IconImageUrl>String</IconImageUrl> <ImageUrl>String</ImageUrl> <Name>String</Name> <Position>0</Position> <Slug>String</Slug> </CategoryTreeDto> </Children> <IconImageUrl>String</IconImageUrl> <ImageUrl>String</ImageUrl> <Name>String</Name> <Position>0</Position> <Slug>String</Slug> </CategoryTreeDto> </Children> <IconImageUrl>String</IconImageUrl> <ImageUrl>String</ImageUrl> <Name>String</Name> <Position>0</Position> <Slug>String</Slug> </CategoryTreeDto> </Categories> <Claimed>false</Claimed> <Contact xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common"> <d4p1:Email>String</d4p1:Email> <d4p1:Phone>String</d4p1:Phone> <d4p1:WebShop>String</d4p1:WebShop> <d4p1:Website>String</d4p1:Website> </Contact> <CountryCode>String</CountryCode> <Floor>String</Floor> <Guid>00000000-0000-0000-0000-000000000000</Guid> <Id>0</Id> <ImageUrl xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common"> <d4p1:Large>String</d4p1:Large> <d4p1:Medium>String</d4p1:Medium> <d4p1:Preview>String</d4p1:Preview> <d4p1:Small>String</d4p1:Small> </ImageUrl> <Latitude>0</Latitude> <LogoUrl xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common"> <d4p1:Large>String</d4p1:Large> <d4p1:Medium>String</d4p1:Medium> <d4p1:Preview>String</d4p1:Preview> <d4p1:Small>String</d4p1:Small> </LogoUrl> <Longitude>0</Longitude> <Name>String</Name> <OpeningHours xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common"> <d4p1:Weekly> <d4p1:Friday> <d4p1:CloseAtHour>0</d4p1:CloseAtHour> <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute> <d4p1:OpenAtHour>0</d4p1:OpenAtHour> <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute> </d4p1:Friday> <d4p1:Monday> <d4p1:CloseAtHour>0</d4p1:CloseAtHour> <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute> <d4p1:OpenAtHour>0</d4p1:OpenAtHour> <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute> </d4p1:Monday> <d4p1:Saturday> <d4p1:CloseAtHour>0</d4p1:CloseAtHour> <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute> <d4p1:OpenAtHour>0</d4p1:OpenAtHour> <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute> </d4p1:Saturday> <d4p1:Sunday> <d4p1:CloseAtHour>0</d4p1:CloseAtHour> <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute> <d4p1:OpenAtHour>0</d4p1:OpenAtHour> <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute> </d4p1:Sunday> <d4p1:Thursday> <d4p1:CloseAtHour>0</d4p1:CloseAtHour> <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute> <d4p1:OpenAtHour>0</d4p1:OpenAtHour> <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute> </d4p1:Thursday> <d4p1:Tuesday> <d4p1:CloseAtHour>0</d4p1:CloseAtHour> <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute> <d4p1:OpenAtHour>0</d4p1:OpenAtHour> <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute> </d4p1:Tuesday> <d4p1:Wednesday> <d4p1:CloseAtHour>0</d4p1:CloseAtHour> <d4p1:CloseAtMinute>0</d4p1:CloseAtMinute> <d4p1:OpenAtHour>0</d4p1:OpenAtHour> <d4p1:OpenAtMinute>0</d4p1:OpenAtMinute> </d4p1:Wednesday> </d4p1:Weekly> </OpeningHours> <OrganizationNumber>String</OrganizationNumber> <OutdoorSeating>false</OutdoorSeating> <Overview>String</Overview> <PlaceType>Mall</PlaceType> <PriceMainDish> <Slug>Value</Slug> <Title>String</Title> </PriceMainDish> <SaveFoodAndMoney>false</SaveFoodAndMoney> <TimeZoneDto xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common"> <d4p1:BaseUtcOffset>PT0S</d4p1:BaseUtcOffset> <d4p1:DaylightName>String</d4p1:DaylightName> <d4p1:DisplayName>String</d4p1:DisplayName> <d4p1:Id>String</d4p1:Id> <d4p1:StandardName>String</d4p1:StandardName> <d4p1:SupportsDaylightSavingTime>false</d4p1:SupportsDaylightSavingTime> </TimeZoneDto> <WearPriceProfiles> <WearPriceProfileDto> <Label>String</Label> <Slug>String</Slug> </WearPriceProfileDto> </WearPriceProfiles> <WheelchairAccessible>false</WheelchairAccessible> <Wifi>false</Wifi> </Place> <PublishAt xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </PublishAt> <StarredCount>0</StarredCount> <StartAt xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </StartAt> <StopAt xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </StopAt> <Title>String</Title> </AdMessageDto> </GetAdMessageResponse>