ConsumerApi

<back to all web services

FindAdMessageRequest

Consumer
Requires Authentication
Required role:Consumer
namespace ConsumerApi

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

F# FindAdMessageRequest 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.

POST /xml/reply/FindAdMessageRequest HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FindAdMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <CacheVersion>0</CacheVersion>
  <Filter>
    <AdMessageGuid>00000000-0000-0000-0000-000000000000</AdMessageGuid>
    <BarSpecialitySlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </BarSpecialitySlugs>
    <BarTypeSlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </BarTypeSlugs>
    <BrandNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </BrandNames>
    <CategoryAbsoluteSlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </CategoryAbsoluteSlugs>
    <CuisineSlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </CuisineSlugs>
    <EatingSuitabilitySlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </EatingSuitabilitySlugs>
    <MealTypeSlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </MealTypeSlugs>
    <OpenAt xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:Hour>0</d3p1:Hour>
      <d3p1:Minute>0</d3p1:Minute>
      <d3p1:WeekDay>Sunday</d3p1:WeekDay>
    </OpenAt>
    <OutdoorSeating>false</OutdoorSeating>
    <Parking xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Database">
      <d3p1:Parking>StreetParking</d3p1:Parking>
    </Parking>
    <PaymentOptions xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Database">
      <d3p1:PaymentOption>Visa</d3p1:PaymentOption>
    </PaymentOptions>
    <PlaceGuid>00000000-0000-0000-0000-000000000000</PlaceGuid>
    <PriceMainDishes xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Database">
      <d3p1:PriceMainDish>Value</d3p1:PriceMainDish>
    </PriceMainDishes>
    <SaveFoodAndMoney>false</SaveFoodAndMoney>
    <TakeAwaySlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </TakeAwaySlugs>
    <Term>String</Term>
    <WearPriceProfileSlugs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </WearPriceProfileSlugs>
    <WheelChairAccessible>false</WheelChairAccessible>
    <Wifi>false</Wifi>
  </Filter>
  <Location>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
    <SearchRadiusInKm>0</SearchRadiusInKm>
  </Location>
  <Offset>0</Offset>
  <ResultAt>0001-01-01T00:00:00</ResultAt>
  <Size>0</Size>
</FindAdMessageRequest>

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

<FindAdMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsumerApi.Dto">
  <AdMessageCount>0</AdMessageCount>
  <AdMessageSaveFoodAndMoneyCount>0</AdMessageSaveFoodAndMoneyCount>
  <AdMessages>
    <AdMessageDto>
      <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>
        <Brands>
          <PlaceSelectedBrandDto>
            <Brand>
              <Name>String</Name>
            </Brand>
            <CategoryAbsoluteSlugs xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1: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: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>
        <ImageUrl xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:Large>String</d5p1:Large>
          <d5p1:Medium>String</d5p1:Medium>
          <d5p1:Preview>String</d5p1:Preview>
          <d5p1:Small>String</d5p1:Small>
        </ImageUrl>
        <Latitude>0</Latitude>
        <LogoUrl xmlns:d5p1="http://schemas.datacontract.org/2004/07/Entities.Common">
          <d5p1:Large>String</d5p1:Large>
          <d5p1:Medium>String</d5p1:Medium>
          <d5p1:Preview>String</d5p1:Preview>
          <d5p1:Small>String</d5p1:Small>
        </LogoUrl>
        <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>
        <OutdoorSeating>false</OutdoorSeating>
        <Overview>String</Overview>
        <PlaceType>Mall</PlaceType>
        <PriceMainDish>
          <Slug>Value</Slug>
          <Title>String</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>
        <WearPriceProfiles>
          <WearPriceProfileDto>
            <Label>String</Label>
            <Slug>String</Slug>
          </WearPriceProfileDto>
        </WearPriceProfiles>
        <WheelchairAccessible>false</WheelchairAccessible>
        <Wifi>false</Wifi>
      </Place>
      <PublishAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </PublishAt>
      <StarredCount>0</StarredCount>
      <StartAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </StartAt>
      <StopAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </StopAt>
      <Title>String</Title>
    </AdMessageDto>
  </AdMessages>
  <CategoryFacetTrees>
    <CategoryFacetTreeDto>
      <AbsoluteSlug>String</AbsoluteSlug>
      <AllImageUrl>String</AllImageUrl>
      <Children>
        <CategoryFacetTreeDto>
          <AbsoluteSlug>String</AbsoluteSlug>
          <AllImageUrl>String</AllImageUrl>
          <Children>
            <CategoryFacetTreeDto>
              <AbsoluteSlug>String</AbsoluteSlug>
              <AllImageUrl>String</AllImageUrl>
              <Children i:nil="true" />
              <Count>0</Count>
              <FeatureTypes xmlns:d8p1="http://schemas.datacontract.org/2004/07/Entities.Database">
                <d8p1:FeatureType>BarSpeciality</d8p1:FeatureType>
              </FeatureTypes>
              <IconImageUrl>String</IconImageUrl>
              <ImageUrl>String</ImageUrl>
              <Name>String</Name>
              <Position>0</Position>
              <Slug>String</Slug>
              <Type>Parent</Type>
            </CategoryFacetTreeDto>
          </Children>
          <Count>0</Count>
          <FeatureTypes xmlns:d6p1="http://schemas.datacontract.org/2004/07/Entities.Database">
            <d6p1:FeatureType>BarSpeciality</d6p1:FeatureType>
          </FeatureTypes>
          <IconImageUrl>String</IconImageUrl>
          <ImageUrl>String</ImageUrl>
          <Name>String</Name>
          <Position>0</Position>
          <Slug>String</Slug>
          <Type>Parent</Type>
        </CategoryFacetTreeDto>
      </Children>
      <Count>0</Count>
      <FeatureTypes xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Database">
        <d4p1:FeatureType>BarSpeciality</d4p1:FeatureType>
      </FeatureTypes>
      <IconImageUrl>String</IconImageUrl>
      <ImageUrl>String</ImageUrl>
      <Name>String</Name>
      <Position>0</Position>
      <Slug>String</Slug>
      <Type>Parent</Type>
    </CategoryFacetTreeDto>
  </CategoryFacetTrees>
  <ResultAt>0001-01-01T00:00:00</ResultAt>
</FindAdMessageResponse>