BusinessApi

GetAdRequest

Business

**Requires Authentication**
Required role:	Business

The following routes are available for this service:
GET	/ad/get

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BusinessApi;

namespace BusinessApi
{
    public partial class AdDetailsAbsoluteDiscountOnSelectedMerchandise
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsAbsoluteDiscountRangeOnAllMerchandise
        : AdDetailsBase
    {
        public double Start { get; set; }
        public double Stop { get; set; }
    }

    public partial class AdDetailsBase
    {
        public string? Description { get; set; }
        public List<string>? MoreInformation { get; set; } = [];
    }

    public partial class AdDetailsFreetext
        : AdDetailsBase
    {
        public string Title { get; set; }
    }

    public partial class AdDetailsHappyHour
        : AdDetailsBase
    {
    }

    public partial class AdDetailsNewArrivals
        : AdDetailsBase
    {
    }

    public partial class AdDetailsPercentageDiscountOnAllMerchandise
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsPercentageDiscountOnSelectedMerchandise
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsPercentageDiscountRangeOnAllMerchandise
        : AdDetailsBase
    {
        public double Start { get; set; }
        public double Stop { get; set; }
    }

    public partial class AdDetailsPercentageOffYourFoodBill
        : AdDetailsBase
    {
        public double Percentage { get; set; }
    }

    public partial class AdDetailsSaveFoodAndMoney
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsSomeFreeTablesLeftToday
        : AdDetailsBase
    {
    }

    public partial class AdDetailsTodaysBreakFastOffer
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsTodaysDinnerOffer
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsTodaysLunchOffer
        : AdDetailsBase
    {
        public double Value { get; set; }
    }

    public partial class AdDetailsTotalAmountOverXgivesYdiscount
        : AdDetailsBase
    {
        public double IfTotalAmountMoreThanX { get; set; }
        public double ThenYouGetDiscountPercentageY { get; set; }
    }

    public partial class AdDetailsTwoDishesForThePriceOfOne
        : AdDetailsBase
    {
    }

    public partial class AdDetailsUnion
    {
        public AdDetailsPercentageDiscountOnAllMerchandise? PercentageOnAllMerchandise { get; set; }
        public AdDetailsPercentageDiscountRangeOnAllMerchandise? PercentageRangeOnAllMerchandise { get; set; }
        public AdDetailsPercentageDiscountOnSelectedMerchandise? PercentageOnSelectedMerchandise { get; set; }
        public AdDetailsAbsoluteDiscountOnSelectedMerchandise? AbsoluteOnSelectedMerchandise { get; set; }
        public AdDetailsAbsoluteDiscountRangeOnAllMerchandise? AbsoluteRangeOnAllMerchandise { get; set; }
        public AdDetailsTotalAmountOverXgivesYdiscount? TotalAmountOverXgivesYdiscount { get; set; }
        public AdDetailsXforYdiscount? XforY { get; set; }
        public AdDetailsNewArrivals? NewArrivals { get; set; }
        public AdDetailsFreetext? Freetext { get; set; }
        public AdDetailsTodaysBreakFastOffer? TodaysBreakFastOffer { get; set; }
        public AdDetailsTodaysLunchOffer? TodaysLunchOffer { get; set; }
        public AdDetailsTodaysDinnerOffer? TodaysDinnerOffer { get; set; }
        public AdDetailsSaveFoodAndMoney? SaveFoodAndMoney { get; set; }
        public AdDetailsPercentageOffYourFoodBill? PercentageOfYourFoodBill { get; set; }
        public AdDetailsHappyHour? HappyHour { get; set; }
        public AdDetailsSomeFreeTablesLeftToday? SomeFreeTablesLeftToday { get; set; }
        public AdDetailsTwoDishesForThePriceOfOne? TwoDishesForThePriceOfOne { get; set; }
    }

    public partial class AdDetailsXforYdiscount
        : AdDetailsBase
    {
        public int IfYouBuyX { get; set; }
        public int ThenYouGetY { get; set; }
    }

    public partial class ImageUrls
    {
        public string Preview { get; set; }
        public string Small { get; set; }
        public string Medium { get; set; }
        public string Large { get; set; }
    }

    public partial class OpeningHour
    {
        public int OpenAtHour { get; set; }
        public int OpenAtMinute { get; set; }
        public int CloseAtHour { get; set; }
        public int CloseAtMinute { get; set; }
    }

    public partial class OpeningHours
    {
        public WeeklyOpeningHours Weekly { get; set; }
    }

    public partial class PlaceAddress
    {
        public string Street { get; set; }
        public string PostalCode { get; set; }
        public string Region { get; set; }
        public string CountryCode { get; set; }
    }

    public partial class PlaceContact
    {
        public string? Phone { get; set; }
        public string? Email { get; set; }
        public string? Website { get; set; }
        public string? WebShop { get; set; }
    }

    public enum PlaceType
    {
        Mall,
        Regular,
    }

    public partial class PriceMainDishDto
    {
        public string Title { get; set; }
        public PriceMainDish Slug { get; set; }
    }

    public partial class TimeZoneDto
    {
        public TimeSpan BaseUtcOffset { get; set; }
        public string DaylightName { get; set; }
        public string DisplayName { get; set; }
        public string Id { get; set; }
        public string StandardName { get; set; }
        public bool SupportsDaylightSavingTime { get; set; }
    }

    public partial class WeeklyOpeningHours
    {
        public OpeningHour? Monday { get; set; }
        public OpeningHour? Tuesday { get; set; }
        public OpeningHour? Wednesday { get; set; }
        public OpeningHour? Thursday { get; set; }
        public OpeningHour? Friday { get; set; }
        public OpeningHour? Saturday { get; set; }
        public OpeningHour? Sunday { get; set; }
    }

    public enum PriceMainDish
    {
        Value,
        Medium,
        High,
        FineDining,
    }

}

C# GetAdRequest 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 /ad/get HTTP/1.1 
Host: qa-business-api.brovs.com 
Accept: application/xml

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

<GetAdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Ad>
    <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>
      <BusinessId>0</BusinessId>
      <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>
      <Latitude>0</Latitude>
      <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>
      <OtherServices>
        <MallOtherServiceDto>
          <Floor>String</Floor>
          <Id>0</Id>
          <ServiceName>String</ServiceName>
        </MallOtherServiceDto>
      </OtherServices>
      <OutdoorSeating>false</OutdoorSeating>
      <Overview>String</Overview>
      <PlaceType>Mall</PlaceType>
      <PriceMainDish xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:Slug>Value</d4p1:Slug>
        <d4p1:Title>String</d4p1: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>
      <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:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UpdatedAt>
  </Ad>
</GetAdResponse>