BusinessApi

<back to all web services

GetAdMessageTitleRequest

Business
Requires Authentication
Required role:Business
GetAdMessageTitleRequest Parameters:
NameParameterData TypeRequiredDescription
DetailsUnionqueryAdMessageDetailsUnionYes
AdMessageDetailsUnion Parameters:
NameParameterData TypeRequiredDescription
PercentageOnAllMerchandiseformAdMessageDetailsPercentageDiscountOnAllMerchandiseNo
PercentageRangeOnAllMerchandiseformAdMessageDetailsPercentageDiscountRangeOnAllMerchandiseNo
PercentageOnSelectedMerchandiseformAdMessageDetailsPercentageDiscountOnSelectedMerchandiseNo
AbsoluteOnSelectedMerchandiseformAdMessageDetailsAbsoluteDiscountOnSelectedMerchandiseNo
AbsoluteRangeOnAllMerchandiseformAdMessageDetailsAbsoluteDiscountRangeOnAllMerchandiseNo
TotalAmountOverXgivesYdiscountformAdMessageDetailsTotalAmountOverXgivesYdiscountNo
XforYformAdMessageDetailsXforYdiscountNo
NewArrivalsformAdMessageDetailsNewArrivalsNo
FreetextformAdMessageDetailsFreetextNo
TodaysBreakFastOfferformAdMessageDetailsTodaysBreakFastOfferNo
TodaysLunchOfferformAdMessageDetailsTodaysLunchOfferNo
TodaysDinnerOfferformAdMessageDetailsTodaysDinnerOfferNo
SaveFoodAndMoneyformAdMessageDetailsSaveFoodAndMoneyNo
PercentageOfYourFoodBillformAdMessageDetailsPercentageOffYourFoodBillNo
HappyHourformAdMessageDetailsHappyHourNo
SomeFreeTablesLeftTodayformAdMessageDetailsSomeFreeTablesLeftTodayNo
TwoDishesForThePriceOfOneformAdMessageDetailsTwoDishesForThePriceOfOneNo
AdMessageDetailsPercentageDiscountOnAllMerchandise Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsBase Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
MoreInformationformList<string>No
AdMessageDetailsPercentageDiscountRangeOnAllMerchandise Parameters:
NameParameterData TypeRequiredDescription
StartformdoubleNo
StopformdoubleNo
AdMessageDetailsPercentageDiscountOnSelectedMerchandise Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise Parameters:
NameParameterData TypeRequiredDescription
StartformdoubleNo
StopformdoubleNo
AdMessageDetailsTotalAmountOverXgivesYdiscount Parameters:
NameParameterData TypeRequiredDescription
IfTotalAmountMoreThanXformdoubleNo
ThenYouGetDiscountPercentageYformdoubleNo
AdMessageDetailsXforYdiscount Parameters:
NameParameterData TypeRequiredDescription
IfYouBuyXformintNo
ThenYouGetYformintNo
AdMessageDetailsFreetext Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes
AdMessageDetailsTodaysBreakFastOffer Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsTodaysLunchOffer Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsTodaysDinnerOffer Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsSaveFoodAndMoney Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdMessageDetailsPercentageOffYourFoodBill Parameters:
NameParameterData TypeRequiredDescription
PercentageformdoubleNo
GetAdMessageTitleResponse Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsonl/reply/GetAdMessageTitleRequest HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"detailsUnion":{"percentageOnAllMerchandise":{"value":0,"description":"String","moreInformation":["String"]},"percentageRangeOnAllMerchandise":{"start":0,"stop":0,"description":"String","moreInformation":["String"]},"percentageOnSelectedMerchandise":{"value":0,"description":"String","moreInformation":["String"]},"absoluteOnSelectedMerchandise":{"value":0,"description":"String","moreInformation":["String"]},"absoluteRangeOnAllMerchandise":{"start":0,"stop":0,"description":"String","moreInformation":["String"]},"totalAmountOverXgivesYdiscount":{"ifTotalAmountMoreThanX":0,"thenYouGetDiscountPercentageY":0,"description":"String","moreInformation":["String"]},"xforY":{"ifYouBuyX":0,"thenYouGetY":0,"description":"String","moreInformation":["String"]},"newArrivals":{"description":"String","moreInformation":["String"]},"freetext":{"title":"String","description":"String","moreInformation":["String"]},"todaysBreakFastOffer":{"value":0,"description":"String","moreInformation":["String"]},"todaysLunchOffer":{"value":0,"description":"String","moreInformation":["String"]},"todaysDinnerOffer":{"value":0,"description":"String","moreInformation":["String"]},"saveFoodAndMoney":{"value":0,"description":"String","moreInformation":["String"]},"percentageOfYourFoodBill":{"percentage":0,"description":"String","moreInformation":["String"]},"happyHour":{"description":"String","moreInformation":["String"]},"someFreeTablesLeftToday":{"description":"String","moreInformation":["String"]},"twoDishesForThePriceOfOne":{"description":"String","moreInformation":["String"]}}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"title":"String"}