BusinessApi

GetAdMessageTitleRequest

Business

**Requires Authentication**
Required role:	Business

**GetAdMessageTitleRequest** Parameters:
Name	Parameter	Data Type	Required	Description
DetailsUnion	query	AdMessageDetailsUnion	Yes

**AdMessageDetailsUnion** Parameters:
Name	Parameter	Data Type	Required
PercentageOnAllMerchandise	form	AdMessageDetailsPercentageDiscountOnAllMerchandise	No
PercentageRangeOnAllMerchandise	form	AdMessageDetailsPercentageDiscountRangeOnAllMerchandise	No
PercentageOnSelectedMerchandise	form	AdMessageDetailsPercentageDiscountOnSelectedMerchandise	No
AbsoluteOnSelectedMerchandise	form	AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise	No
AbsoluteRangeOnAllMerchandise	form	AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise	No
TotalAmountOverXgivesYdiscount	form	AdMessageDetailsTotalAmountOverXgivesYdiscount	No
XforY	form	AdMessageDetailsXforYdiscount	No
NewArrivals	form	AdMessageDetailsNewArrivals	No
Freetext	form	AdMessageDetailsFreetext	No
TodaysBreakFastOffer	form	AdMessageDetailsTodaysBreakFastOffer	No
TodaysLunchOffer	form	AdMessageDetailsTodaysLunchOffer	No
TodaysDinnerOffer	form	AdMessageDetailsTodaysDinnerOffer	No
SaveFoodAndMoney	form	AdMessageDetailsSaveFoodAndMoney	No
PercentageOfYourFoodBill	form	AdMessageDetailsPercentageOffYourFoodBill	No
HappyHour	form	AdMessageDetailsHappyHour	No
SomeFreeTablesLeftToday	form	AdMessageDetailsSomeFreeTablesLeftToday	No
TwoDishesForThePriceOfOne	form	AdMessageDetailsTwoDishesForThePriceOfOne	No

**AdMessageDetailsPercentageDiscountOnAllMerchandise** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsBase** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	No
MoreInformation	form	List<string>	No

**AdMessageDetailsPercentageDiscountRangeOnAllMerchandise** Parameters:
Name	Parameter	Data Type	Required	Description
Start	form	double	No
Stop	form	double	No

**AdMessageDetailsPercentageDiscountOnSelectedMerchandise** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise** Parameters:
Name	Parameter	Data Type	Required	Description
Start	form	double	No
Stop	form	double	No

**AdMessageDetailsTotalAmountOverXgivesYdiscount** Parameters:
Name	Parameter	Data Type	Required	Description
IfTotalAmountMoreThanX	form	double	No
ThenYouGetDiscountPercentageY	form	double	No

**AdMessageDetailsXforYdiscount** Parameters:
Name	Parameter	Data Type	Required	Description
IfYouBuyX	form	int	No
ThenYouGetY	form	int	No

**AdMessageDetailsFreetext** Parameters:
Name	Parameter	Data Type	Required	Description
Title	form	string	Yes

**AdMessageDetailsTodaysBreakFastOffer** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsTodaysLunchOffer** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsTodaysDinnerOffer** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsSaveFoodAndMoney** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	double	No

**AdMessageDetailsPercentageOffYourFoodBill** Parameters:
Name	Parameter	Data Type	Required	Description
Percentage	form	double	No

**GetAdMessageTitleResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Title	form	string	Yes

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/GetAdMessageTitleRequest HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetAdMessageTitleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <DetailsUnion xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Common">
    <d2p1:AbsoluteOnSelectedMerchandise>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:AbsoluteOnSelectedMerchandise>
    <d2p1:AbsoluteRangeOnAllMerchandise>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Start>0</d2p1:Start>
      <d2p1:Stop>0</d2p1:Stop>
    </d2p1:AbsoluteRangeOnAllMerchandise>
    <d2p1:Freetext>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:Freetext>
    <d2p1:HappyHour>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
    </d2p1:HappyHour>
    <d2p1:NewArrivals>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
    </d2p1:NewArrivals>
    <d2p1:PercentageOfYourFoodBill>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Percentage>0</d2p1:Percentage>
    </d2p1:PercentageOfYourFoodBill>
    <d2p1:PercentageOnAllMerchandise>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:PercentageOnAllMerchandise>
    <d2p1:PercentageOnSelectedMerchandise>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:PercentageOnSelectedMerchandise>
    <d2p1:PercentageRangeOnAllMerchandise>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Start>0</d2p1:Start>
      <d2p1:Stop>0</d2p1:Stop>
    </d2p1:PercentageRangeOnAllMerchandise>
    <d2p1:SaveFoodAndMoney>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:SaveFoodAndMoney>
    <d2p1:SomeFreeTablesLeftToday>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
    </d2p1:SomeFreeTablesLeftToday>
    <d2p1:TodaysBreakFastOffer>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:TodaysBreakFastOffer>
    <d2p1:TodaysDinnerOffer>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:TodaysDinnerOffer>
    <d2p1:TodaysLunchOffer>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:TodaysLunchOffer>
    <d2p1:TotalAmountOverXgivesYdiscount>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:IfTotalAmountMoreThanX>0</d2p1:IfTotalAmountMoreThanX>
      <d2p1:ThenYouGetDiscountPercentageY>0</d2p1:ThenYouGetDiscountPercentageY>
    </d2p1:TotalAmountOverXgivesYdiscount>
    <d2p1:TwoDishesForThePriceOfOne>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
    </d2p1:TwoDishesForThePriceOfOne>
    <d2p1:XforY>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:MoreInformation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MoreInformation>
      <d2p1:IfYouBuyX>0</d2p1:IfYouBuyX>
      <d2p1:ThenYouGetY>0</d2p1:ThenYouGetY>
    </d2p1:XforY>
  </DetailsUnion>
</GetAdMessageTitleRequest>

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

<GetAdMessageTitleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Title>String</Title>
</GetAdMessageTitleResponse>