BusinessApi

GetAdMessagesRequest

Business

**Requires Authentication**
Required role:	Business

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

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 BusinessApi


class VisibilityState(str, Enum):
    DRAFT = 'Draft'
    RUNNING = 'Running'
    UPCOMING = 'Upcoming'
    ARCHIVED = 'Archived'
    PAUSED = 'Paused'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ImageUrls:
    preview: Optional[str] = None
    small: Optional[str] = None
    medium: Optional[str] = None
    large: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OpeningHour:
    open_at_hour: int = 0
    open_at_minute: int = 0
    close_at_hour: int = 0
    close_at_minute: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WeeklyOpeningHours:
    monday: Optional[OpeningHour] = None
    tuesday: Optional[OpeningHour] = None
    wednesday: Optional[OpeningHour] = None
    thursday: Optional[OpeningHour] = None
    friday: Optional[OpeningHour] = None
    saturday: Optional[OpeningHour] = None
    sunday: Optional[OpeningHour] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OpeningHours:
    weekly: Optional[WeeklyOpeningHours] = None


class PlaceType(str, Enum):
    MALL = 'Mall'
    REGULAR = 'Regular'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlaceContact:
    phone: Optional[str] = None
    email: Optional[str] = None
    website: Optional[str] = None
    web_shop: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlaceAddress:
    street: Optional[str] = None
    postal_code: Optional[str] = None
    region: Optional[str] = None
    country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TimeZoneDto:
    base_utc_offset: datetime.timedelta = datetime.timedelta()
    daylight_name: Optional[str] = None
    display_name: Optional[str] = None
    id: Optional[str] = None
    standard_name: Optional[str] = None
    supports_daylight_saving_time: bool = False


class PriceMainDish(str, Enum):
    VALUE = 'Value'
    MEDIUM = 'Medium'
    HIGH = 'High'
    FINE_DINING = 'FineDining'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PriceMainDishDto:
    title: Optional[str] = None
    slug: Optional[PriceMainDish] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsBase:
    description: Optional[str] = None
    more_information: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsPercentageDiscountOnAllMerchandise(AdMessageDetailsBase):
    value: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsPercentageDiscountRangeOnAllMerchandise(AdMessageDetailsBase):
    start: float = 0.0
    stop: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsPercentageDiscountOnSelectedMerchandise(AdMessageDetailsBase):
    value: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise(AdMessageDetailsBase):
    value: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise(AdMessageDetailsBase):
    start: float = 0.0
    stop: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsTotalAmountOverXgivesYdiscount(AdMessageDetailsBase):
    if_total_amount_more_than_x: float = 0.0
    then_you_get_discount_percentage_y: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsXforYdiscount(AdMessageDetailsBase):
    if_you_buy_x: int = 0
    then_you_get_y: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsNewArrivals(AdMessageDetailsBase):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsFreetext(AdMessageDetailsBase):
    title: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsTodaysBreakFastOffer(AdMessageDetailsBase):
    value: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsTodaysLunchOffer(AdMessageDetailsBase):
    value: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsTodaysDinnerOffer(AdMessageDetailsBase):
    value: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsSaveFoodAndMoney(AdMessageDetailsBase):
    value: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsPercentageOffYourFoodBill(AdMessageDetailsBase):
    percentage: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsHappyHour(AdMessageDetailsBase):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsSomeFreeTablesLeftToday(AdMessageDetailsBase):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsTwoDishesForThePriceOfOne(AdMessageDetailsBase):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdMessageDetailsUnion:
    percentage_on_all_merchandise: Optional[AdMessageDetailsPercentageDiscountOnAllMerchandise] = None
    percentage_range_on_all_merchandise: Optional[AdMessageDetailsPercentageDiscountRangeOnAllMerchandise] = None
    percentage_on_selected_merchandise: Optional[AdMessageDetailsPercentageDiscountOnSelectedMerchandise] = None
    absolute_on_selected_merchandise: Optional[AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise] = None
    absolute_range_on_all_merchandise: Optional[AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise] = None
    total_amount_over_xgives_ydiscount: Optional[AdMessageDetailsTotalAmountOverXgivesYdiscount] = None
    xfor_y: Optional[AdMessageDetailsXforYdiscount] = None
    new_arrivals: Optional[AdMessageDetailsNewArrivals] = None
    freetext: Optional[AdMessageDetailsFreetext] = None
    todays_break_fast_offer: Optional[AdMessageDetailsTodaysBreakFastOffer] = None
    todays_lunch_offer: Optional[AdMessageDetailsTodaysLunchOffer] = None
    todays_dinner_offer: Optional[AdMessageDetailsTodaysDinnerOffer] = None
    save_food_and_money: Optional[AdMessageDetailsSaveFoodAndMoney] = None
    percentage_of_your_food_bill: Optional[AdMessageDetailsPercentageOffYourFoodBill] = None
    happy_hour: Optional[AdMessageDetailsHappyHour] = None
    some_free_tables_left_today: Optional[AdMessageDetailsSomeFreeTablesLeftToday] = None
    two_dishes_for_the_price_of_one: Optional[AdMessageDetailsTwoDishesForThePriceOfOne] = None

Python GetAdMessagesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAdMessagesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <AdMessagesWithVisibilityState>
    <BusinessAdMessageDto>
      <DetailsUnion xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:AbsoluteOnSelectedMerchandise>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:AbsoluteOnSelectedMerchandise>
        <d4p1:AbsoluteRangeOnAllMerchandise>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Start>0</d4p1:Start>
          <d4p1:Stop>0</d4p1:Stop>
        </d4p1:AbsoluteRangeOnAllMerchandise>
        <d4p1:Freetext>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Title>String</d4p1:Title>
        </d4p1:Freetext>
        <d4p1:HappyHour>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
        </d4p1:HappyHour>
        <d4p1:NewArrivals>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
        </d4p1:NewArrivals>
        <d4p1:PercentageOfYourFoodBill>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Percentage>0</d4p1:Percentage>
        </d4p1:PercentageOfYourFoodBill>
        <d4p1:PercentageOnAllMerchandise>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:PercentageOnAllMerchandise>
        <d4p1:PercentageOnSelectedMerchandise>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:PercentageOnSelectedMerchandise>
        <d4p1:PercentageRangeOnAllMerchandise>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Start>0</d4p1:Start>
          <d4p1:Stop>0</d4p1:Stop>
        </d4p1:PercentageRangeOnAllMerchandise>
        <d4p1:SaveFoodAndMoney>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:SaveFoodAndMoney>
        <d4p1:SomeFreeTablesLeftToday>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
        </d4p1:SomeFreeTablesLeftToday>
        <d4p1:TodaysBreakFastOffer>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:TodaysBreakFastOffer>
        <d4p1:TodaysDinnerOffer>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:TodaysDinnerOffer>
        <d4p1:TodaysLunchOffer>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:TodaysLunchOffer>
        <d4p1:TotalAmountOverXgivesYdiscount>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:IfTotalAmountMoreThanX>0</d4p1:IfTotalAmountMoreThanX>
          <d4p1:ThenYouGetDiscountPercentageY>0</d4p1:ThenYouGetDiscountPercentageY>
        </d4p1:TotalAmountOverXgivesYdiscount>
        <d4p1:TwoDishesForThePriceOfOne>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
        </d4p1:TwoDishesForThePriceOfOne>
        <d4p1:XforY>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:MoreInformation xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d4p1:MoreInformation>
          <d4p1:IfYouBuyX>0</d4p1:IfYouBuyX>
          <d4p1:ThenYouGetY>0</d4p1:ThenYouGetY>
        </d4p1:XforY>
      </DetailsUnion>
      <Guid>00000000-0000-0000-0000-000000000000</Guid>
      <Id>0</Id>
      <ImageUrls xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:ImageUrls>
          <d4p1:Large>String</d4p1:Large>
          <d4p1:Medium>String</d4p1:Medium>
          <d4p1:Preview>String</d4p1:Preview>
          <d4p1:Small>String</d4p1:Small>
        </d4p1:ImageUrls>
      </ImageUrls>
      <Place>
        <Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:CountryCode>String</d5p1:CountryCode>
          <d5p1:PostalCode>String</d5p1:PostalCode>
          <d5p1:Region>String</d5p1:Region>
          <d5p1:Street>String</d5p1:Street>
        </Address>
        <BusinessId>0</BusinessId>
        <Claimed>false</Claimed>
        <Contact xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:Email>String</d5p1:Email>
          <d5p1:Phone>String</d5p1:Phone>
          <d5p1:WebShop>String</d5p1:WebShop>
          <d5p1:Website>String</d5p1:Website>
        </Contact>
        <CountryCode>String</CountryCode>
        <Floor>String</Floor>
        <Guid>00000000-0000-0000-0000-000000000000</Guid>
        <Id>0</Id>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
        <Name>String</Name>
        <OpeningHours xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:Weekly>
            <d5p1:Friday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Friday>
            <d5p1:Monday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Monday>
            <d5p1:Saturday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Saturday>
            <d5p1:Sunday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Sunday>
            <d5p1:Thursday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Thursday>
            <d5p1:Tuesday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Tuesday>
            <d5p1:Wednesday>
              <d5p1:CloseAtHour>0</d5p1:CloseAtHour>
              <d5p1:CloseAtMinute>0</d5p1:CloseAtMinute>
              <d5p1:OpenAtHour>0</d5p1:OpenAtHour>
              <d5p1:OpenAtMinute>0</d5p1:OpenAtMinute>
            </d5p1:Wednesday>
          </d5p1:Weekly>
        </OpeningHours>
        <OrganizationNumber>String</OrganizationNumber>
        <OtherServices>
          <MallOtherServiceDto>
            <Floor>String</Floor>
            <Id>0</Id>
            <ServiceName>String</ServiceName>
          </MallOtherServiceDto>
        </OtherServices>
        <OutdoorSeating>false</OutdoorSeating>
        <Overview>String</Overview>
        <PlaceType>Mall</PlaceType>
        <PriceMainDish xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:Slug>Value</d5p1:Slug>
          <d5p1:Title>String</d5p1:Title>
        </PriceMainDish>
        <SaveFoodAndMoney>false</SaveFoodAndMoney>
        <TimeZoneDto xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:BaseUtcOffset>PT0S</d5p1:BaseUtcOffset>
          <d5p1:DaylightName>String</d5p1:DaylightName>
          <d5p1:DisplayName>String</d5p1:DisplayName>
          <d5p1:Id>String</d5p1:Id>
          <d5p1:StandardName>String</d5p1:StandardName>
          <d5p1:SupportsDaylightSavingTime>false</d5p1:SupportsDaylightSavingTime>
        </TimeZoneDto>
        <WheelChairAccessible>false</WheelChairAccessible>
        <Wifi>false</Wifi>
      </Place>
      <PublishAt>
        <Day>0</Day>
        <Hour>0</Hour>
        <Minute>0</Minute>
        <Month>0</Month>
        <Second>0</Second>
        <Year>0</Year>
      </PublishAt>
      <StartAt>
        <Day>0</Day>
        <Hour>0</Hour>
        <Minute>0</Minute>
        <Month>0</Month>
        <Second>0</Second>
        <Year>0</Year>
      </StartAt>
      <State>String</State>
      <StopAt>
        <Day>0</Day>
        <Hour>0</Hour>
        <Minute>0</Minute>
        <Month>0</Month>
        <Second>0</Second>
        <Year>0</Year>
      </StopAt>
      <Title>String</Title>
      <UpdatedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </UpdatedAt>
    </BusinessAdMessageDto>
  </AdMessagesWithVisibilityState>
</GetAdMessagesResponse>