BusinessApi

<back to all web services

GetAdMessageRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/admessage/get
namespace BusinessApi

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

    [<AllowNullLiteral>]
    type ImageUrls() = 
        member val Preview:String = null with get,set
        member val Small:String = null with get,set
        member val Medium:String = null with get,set
        member val Large:String = null with get,set

    [<AllowNullLiteral>]
    type OpeningHour() = 
        member val OpenAtHour:Int32 = new Int32() with get,set
        member val OpenAtMinute:Int32 = new Int32() with get,set
        member val CloseAtHour:Int32 = new Int32() with get,set
        member val CloseAtMinute:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type WeeklyOpeningHours() = 
        member val Monday:OpeningHour = null with get,set
        member val Tuesday:OpeningHour = null with get,set
        member val Wednesday:OpeningHour = null with get,set
        member val Thursday:OpeningHour = null with get,set
        member val Friday:OpeningHour = null with get,set
        member val Saturday:OpeningHour = null with get,set
        member val Sunday:OpeningHour = null with get,set

    [<AllowNullLiteral>]
    type OpeningHours() = 
        member val Weekly:WeeklyOpeningHours = null with get,set

    type PlaceType =
        | Mall = 0
        | Regular = 1

    [<AllowNullLiteral>]
    type PlaceContact() = 
        member val Phone:String = null with get,set
        member val Email:String = null with get,set
        member val Website:String = null with get,set
        member val WebShop:String = null with get,set

    [<AllowNullLiteral>]
    type PlaceAddress() = 
        member val Street:String = null with get,set
        member val PostalCode:String = null with get,set
        member val Region:String = null with get,set
        member val CountryCode:String = null with get,set

    [<AllowNullLiteral>]
    type TimeZoneDto() = 
        member val BaseUtcOffset:TimeSpan = new TimeSpan() with get,set
        member val DaylightName:String = null with get,set
        member val DisplayName:String = null with get,set
        member val Id:String = null with get,set
        member val StandardName:String = null with get,set
        member val SupportsDaylightSavingTime:Boolean = new Boolean() with get,set

    type PriceMainDish =
        | Value = 0
        | Medium = 1
        | High = 2
        | FineDining = 3

    [<AllowNullLiteral>]
    type PriceMainDishDto() = 
        member val Title:String = null with get,set
        member val Slug:PriceMainDish = new PriceMainDish() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsBase() = 
        member val Description:String = null with get,set
        member val MoreInformation:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsPercentageDiscountOnAllMerchandise() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsPercentageDiscountRangeOnAllMerchandise() = 
        inherit AdMessageDetailsBase()
        member val Start:Double = new Double() with get,set
        member val Stop:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsPercentageDiscountOnSelectedMerchandise() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise() = 
        inherit AdMessageDetailsBase()
        member val Start:Double = new Double() with get,set
        member val Stop:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsTotalAmountOverXgivesYdiscount() = 
        inherit AdMessageDetailsBase()
        member val IfTotalAmountMoreThanX:Double = new Double() with get,set
        member val ThenYouGetDiscountPercentageY:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsXforYdiscount() = 
        inherit AdMessageDetailsBase()
        member val IfYouBuyX:Int32 = new Int32() with get,set
        member val ThenYouGetY:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsNewArrivals() = 
        inherit AdMessageDetailsBase()

    [<AllowNullLiteral>]
    type AdMessageDetailsFreetext() = 
        inherit AdMessageDetailsBase()
        member val Title:String = null with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsTodaysBreakFastOffer() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsTodaysLunchOffer() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsTodaysDinnerOffer() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsSaveFoodAndMoney() = 
        inherit AdMessageDetailsBase()
        member val Value:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsPercentageOffYourFoodBill() = 
        inherit AdMessageDetailsBase()
        member val Percentage:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type AdMessageDetailsHappyHour() = 
        inherit AdMessageDetailsBase()

    [<AllowNullLiteral>]
    type AdMessageDetailsSomeFreeTablesLeftToday() = 
        inherit AdMessageDetailsBase()

    [<AllowNullLiteral>]
    type AdMessageDetailsTwoDishesForThePriceOfOne() = 
        inherit AdMessageDetailsBase()

    [<AllowNullLiteral>]
    type AdMessageDetailsUnion() = 
        member val PercentageOnAllMerchandise:AdMessageDetailsPercentageDiscountOnAllMerchandise = null with get,set
        member val PercentageRangeOnAllMerchandise:AdMessageDetailsPercentageDiscountRangeOnAllMerchandise = null with get,set
        member val PercentageOnSelectedMerchandise:AdMessageDetailsPercentageDiscountOnSelectedMerchandise = null with get,set
        member val AbsoluteOnSelectedMerchandise:AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise = null with get,set
        member val AbsoluteRangeOnAllMerchandise:AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise = null with get,set
        member val TotalAmountOverXgivesYdiscount:AdMessageDetailsTotalAmountOverXgivesYdiscount = null with get,set
        member val XforY:AdMessageDetailsXforYdiscount = null with get,set
        member val NewArrivals:AdMessageDetailsNewArrivals = null with get,set
        member val Freetext:AdMessageDetailsFreetext = null with get,set
        member val TodaysBreakFastOffer:AdMessageDetailsTodaysBreakFastOffer = null with get,set
        member val TodaysLunchOffer:AdMessageDetailsTodaysLunchOffer = null with get,set
        member val TodaysDinnerOffer:AdMessageDetailsTodaysDinnerOffer = null with get,set
        member val SaveFoodAndMoney:AdMessageDetailsSaveFoodAndMoney = null with get,set
        member val PercentageOfYourFoodBill:AdMessageDetailsPercentageOffYourFoodBill = null with get,set
        member val HappyHour:AdMessageDetailsHappyHour = null with get,set
        member val SomeFreeTablesLeftToday:AdMessageDetailsSomeFreeTablesLeftToday = null with get,set
        member val TwoDishesForThePriceOfOne:AdMessageDetailsTwoDishesForThePriceOfOne = null with get,set

F# GetAdMessageRequest 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 HTTP/1.1 
Host: business-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/BusinessApi.Dto">
  <AdMessage>
    <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>
  </AdMessage>
</GetAdMessageResponse>