BusinessApi

<back to all web services

GetAdTitleRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/ad/get-title
GetAdTitleRequest Parameters:
NameParameterData TypeRequiredDescription
DetailsUnionqueryAdDetailsUnionYes
AdDetailsUnion Parameters:
NameParameterData TypeRequiredDescription
PercentageOnAllMerchandiseformAdDetailsPercentageDiscountOnAllMerchandiseNo
PercentageRangeOnAllMerchandiseformAdDetailsPercentageDiscountRangeOnAllMerchandiseNo
PercentageOnSelectedMerchandiseformAdDetailsPercentageDiscountOnSelectedMerchandiseNo
AbsoluteOnSelectedMerchandiseformAdDetailsAbsoluteDiscountOnSelectedMerchandiseNo
AbsoluteRangeOnAllMerchandiseformAdDetailsAbsoluteDiscountRangeOnAllMerchandiseNo
TotalAmountOverXgivesYdiscountformAdDetailsTotalAmountOverXgivesYdiscountNo
XforYformAdDetailsXforYdiscountNo
NewArrivalsformAdDetailsNewArrivalsNo
FreetextformAdDetailsFreetextNo
TodaysBreakFastOfferformAdDetailsTodaysBreakFastOfferNo
TodaysLunchOfferformAdDetailsTodaysLunchOfferNo
TodaysDinnerOfferformAdDetailsTodaysDinnerOfferNo
SaveFoodAndMoneyformAdDetailsSaveFoodAndMoneyNo
PercentageOfYourFoodBillformAdDetailsPercentageOffYourFoodBillNo
HappyHourformAdDetailsHappyHourNo
SomeFreeTablesLeftTodayformAdDetailsSomeFreeTablesLeftTodayNo
TwoDishesForThePriceOfOneformAdDetailsTwoDishesForThePriceOfOneNo
AdDetailsPercentageDiscountOnAllMerchandise Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdDetailsBase Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
MoreInformationformList<string>No
AdDetailsPercentageDiscountRangeOnAllMerchandise Parameters:
NameParameterData TypeRequiredDescription
StartformdoubleNo
StopformdoubleNo
AdDetailsPercentageDiscountOnSelectedMerchandise Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdDetailsAbsoluteDiscountOnSelectedMerchandise Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdDetailsAbsoluteDiscountRangeOnAllMerchandise Parameters:
NameParameterData TypeRequiredDescription
StartformdoubleNo
StopformdoubleNo
AdDetailsTotalAmountOverXgivesYdiscount Parameters:
NameParameterData TypeRequiredDescription
IfTotalAmountMoreThanXformdoubleNo
ThenYouGetDiscountPercentageYformdoubleNo
AdDetailsXforYdiscount Parameters:
NameParameterData TypeRequiredDescription
IfYouBuyXformintNo
ThenYouGetYformintNo
AdDetailsFreetext Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes
AdDetailsTodaysBreakFastOffer Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdDetailsTodaysLunchOffer Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdDetailsTodaysDinnerOffer Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdDetailsSaveFoodAndMoney Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo
AdDetailsPercentageOffYourFoodBill Parameters:
NameParameterData TypeRequiredDescription
PercentageformdoubleNo
GetAdTitleResponse Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes

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

HTTP + JSV

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

GET /ad/get-title HTTP/1.1 
Host: qa-business-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	title: String
}