ConsumerApi

GetStarredAdMessageListRequest

Consumer

**Requires Authentication**
Required role:	Consumer

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

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 GetStarredAdMessageListRequest 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/GetStarredAdMessageList HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: application/xml

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

<GetStarredAdMessageListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <StarredList>
    <StarredDto>
      <AdMessage>
        <DetailsUnion xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:AbsoluteOnSelectedMerchandise>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:AbsoluteOnSelectedMerchandise>
          <d5p1:AbsoluteRangeOnAllMerchandise>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:Start>0</d5p1:Start>
            <d5p1:Stop>0</d5p1:Stop>
          </d5p1:AbsoluteRangeOnAllMerchandise>
          <d5p1:Freetext>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:Title>String</d5p1:Title>
          </d5p1:Freetext>
          <d5p1:HappyHour>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
          </d5p1:HappyHour>
          <d5p1:NewArrivals>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
          </d5p1:NewArrivals>
          <d5p1:PercentageOfYourFoodBill>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:Percentage>0</d5p1:Percentage>
          </d5p1:PercentageOfYourFoodBill>
          <d5p1:PercentageOnAllMerchandise>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:PercentageOnAllMerchandise>
          <d5p1:PercentageOnSelectedMerchandise>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:PercentageOnSelectedMerchandise>
          <d5p1:PercentageRangeOnAllMerchandise>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:Start>0</d5p1:Start>
            <d5p1:Stop>0</d5p1:Stop>
          </d5p1:PercentageRangeOnAllMerchandise>
          <d5p1:SaveFoodAndMoney>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:SaveFoodAndMoney>
          <d5p1:SomeFreeTablesLeftToday>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
          </d5p1:SomeFreeTablesLeftToday>
          <d5p1:TodaysBreakFastOffer>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:TodaysBreakFastOffer>
          <d5p1:TodaysDinnerOffer>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:TodaysDinnerOffer>
          <d5p1:TodaysLunchOffer>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:TodaysLunchOffer>
          <d5p1:TotalAmountOverXgivesYdiscount>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:IfTotalAmountMoreThanX>0</d5p1:IfTotalAmountMoreThanX>
            <d5p1:ThenYouGetDiscountPercentageY>0</d5p1:ThenYouGetDiscountPercentageY>
          </d5p1:TotalAmountOverXgivesYdiscount>
          <d5p1:TwoDishesForThePriceOfOne>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
          </d5p1:TwoDishesForThePriceOfOne>
          <d5p1:XforY>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:MoreInformation xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d5p1:MoreInformation>
            <d5p1:IfYouBuyX>0</d5p1:IfYouBuyX>
            <d5p1:ThenYouGetY>0</d5p1:ThenYouGetY>
          </d5p1:XforY>
        </DetailsUnion>
        <Guid>00000000-0000-0000-0000-000000000000</Guid>
        <Id>0</Id>
        <ImageUrls xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:ImageUrls>
            <d5p1:Large>String</d5p1:Large>
            <d5p1:Medium>String</d5p1:Medium>
            <d5p1:Preview>String</d5p1:Preview>
            <d5p1:Small>String</d5p1:Small>
          </d5p1:ImageUrls>
        </ImageUrls>
        <Place>
          <Address xmlns:d6p1="http://schemas.datacontract.org/2004/07/Entities.Common">
            <d6p1:CountryCode>String</d6p1:CountryCode>
            <d6p1:PostalCode>String</d6p1:PostalCode>
            <d6p1:Region>String</d6p1:Region>
            <d6p1:Street>String</d6p1:Street>
          </Address>
          <Brands>
            <PlaceSelectedBrandDto>
              <Brand>
                <Name>String</Name>
              </Brand>
              <CategoryAbsoluteSlugs xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>String</d8p1: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:d6p1="http://schemas.datacontract.org/2004/07/Entities.Common">
            <d6p1:Email>String</d6p1:Email>
            <d6p1:Phone>String</d6p1:Phone>
            <d6p1:WebShop>String</d6p1:WebShop>
            <d6p1:Website>String</d6p1:Website>
          </Contact>
          <CountryCode>String</CountryCode>
          <Floor>String</Floor>
          <Guid>00000000-0000-0000-0000-000000000000</Guid>
          <Id>0</Id>
          <ImageUrl xmlns:d6p1="http://schemas.datacontract.org/2004/07/Entities.Common">
            <d6p1:Large>String</d6p1:Large>
            <d6p1:Medium>String</d6p1:Medium>
            <d6p1:Preview>String</d6p1:Preview>
            <d6p1:Small>String</d6p1:Small>
          </ImageUrl>
          <Latitude>0</Latitude>
          <LogoUrl xmlns:d6p1="http://schemas.datacontract.org/2004/07/Entities.Common">
            <d6p1:Large>String</d6p1:Large>
            <d6p1:Medium>String</d6p1:Medium>
            <d6p1:Preview>String</d6p1:Preview>
            <d6p1:Small>String</d6p1:Small>
          </LogoUrl>
          <Longitude>0</Longitude>
          <Name>String</Name>
          <OpeningHours xmlns:d6p1="http://schemas.datacontract.org/2004/07/Entities.Common">
            <d6p1:Weekly>
              <d6p1:Friday>
                <d6p1:CloseAtHour>0</d6p1:CloseAtHour>
                <d6p1:CloseAtMinute>0</d6p1:CloseAtMinute>
                <d6p1:OpenAtHour>0</d6p1:OpenAtHour>
                <d6p1:OpenAtMinute>0</d6p1:OpenAtMinute>
              </d6p1:Friday>
              <d6p1:Monday>
                <d6p1:CloseAtHour>0</d6p1:CloseAtHour>
                <d6p1:CloseAtMinute>0</d6p1:CloseAtMinute>
                <d6p1:OpenAtHour>0</d6p1:OpenAtHour>
                <d6p1:OpenAtMinute>0</d6p1:OpenAtMinute>
              </d6p1:Monday>
              <d6p1:Saturday>
                <d6p1:CloseAtHour>0</d6p1:CloseAtHour>
                <d6p1:CloseAtMinute>0</d6p1:CloseAtMinute>
                <d6p1:OpenAtHour>0</d6p1:OpenAtHour>
                <d6p1:OpenAtMinute>0</d6p1:OpenAtMinute>
              </d6p1:Saturday>
              <d6p1:Sunday>
                <d6p1:CloseAtHour>0</d6p1:CloseAtHour>
                <d6p1:CloseAtMinute>0</d6p1:CloseAtMinute>
                <d6p1:OpenAtHour>0</d6p1:OpenAtHour>
                <d6p1:OpenAtMinute>0</d6p1:OpenAtMinute>
              </d6p1:Sunday>
              <d6p1:Thursday>
                <d6p1:CloseAtHour>0</d6p1:CloseAtHour>
                <d6p1:CloseAtMinute>0</d6p1:CloseAtMinute>
                <d6p1:OpenAtHour>0</d6p1:OpenAtHour>
                <d6p1:OpenAtMinute>0</d6p1:OpenAtMinute>
              </d6p1:Thursday>
              <d6p1:Tuesday>
                <d6p1:CloseAtHour>0</d6p1:CloseAtHour>
                <d6p1:CloseAtMinute>0</d6p1:CloseAtMinute>
                <d6p1:OpenAtHour>0</d6p1:OpenAtHour>
                <d6p1:OpenAtMinute>0</d6p1:OpenAtMinute>
              </d6p1:Tuesday>
              <d6p1:Wednesday>
                <d6p1:CloseAtHour>0</d6p1:CloseAtHour>
                <d6p1:CloseAtMinute>0</d6p1:CloseAtMinute>
                <d6p1:OpenAtHour>0</d6p1:OpenAtHour>
                <d6p1:OpenAtMinute>0</d6p1:OpenAtMinute>
              </d6p1:Wednesday>
            </d6p1: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:d6p1="http://schemas.datacontract.org/2004/07/Entities.Common">
            <d6p1:BaseUtcOffset>PT0S</d6p1:BaseUtcOffset>
            <d6p1:DaylightName>String</d6p1:DaylightName>
            <d6p1:DisplayName>String</d6p1:DisplayName>
            <d6p1:Id>String</d6p1:Id>
            <d6p1:StandardName>String</d6p1:StandardName>
            <d6p1:SupportsDaylightSavingTime>false</d6p1:SupportsDaylightSavingTime>
          </TimeZoneDto>
          <WearPriceProfiles>
            <WearPriceProfileDto>
              <Label>String</Label>
              <Slug>String</Slug>
            </WearPriceProfileDto>
          </WearPriceProfiles>
          <WheelchairAccessible>false</WheelchairAccessible>
          <Wifi>false</Wifi>
        </Place>
        <PublishAt xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </PublishAt>
        <StarredCount>0</StarredCount>
        <StartAt xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </StartAt>
        <StopAt xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </StopAt>
        <Title>String</Title>
      </AdMessage>
    </StarredDto>
  </StarredList>
</GetStarredAdMessageListResponse>