BusinessApi

<back to all web services

GetAdMessageTitleRequest

Business
Requires Authentication
Required role:Business
"use strict";
export class AdMessageDetailsBase {
    /** @param {{description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    description;
    /** @type {?string[]} */
    moreInformation = [];
}
export class AdMessageDetailsPercentageDiscountOnAllMerchandise extends AdMessageDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdMessageDetailsPercentageDiscountRangeOnAllMerchandise extends AdMessageDetailsBase {
    /** @param {{start?:number,stop?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    start;
    /** @type {?number} */
    stop;
}
export class AdMessageDetailsPercentageDiscountOnSelectedMerchandise extends AdMessageDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise extends AdMessageDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise extends AdMessageDetailsBase {
    /** @param {{start?:number,stop?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    start;
    /** @type {?number} */
    stop;
}
export class AdMessageDetailsTotalAmountOverXgivesYdiscount extends AdMessageDetailsBase {
    /** @param {{ifTotalAmountMoreThanX?:number,thenYouGetDiscountPercentageY?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    ifTotalAmountMoreThanX;
    /** @type {?number} */
    thenYouGetDiscountPercentageY;
}
export class AdMessageDetailsXforYdiscount extends AdMessageDetailsBase {
    /** @param {{ifYouBuyX?:number,thenYouGetY?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    ifYouBuyX;
    /** @type {?number} */
    thenYouGetY;
}
export class AdMessageDetailsNewArrivals extends AdMessageDetailsBase {
    /** @param {{description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class AdMessageDetailsFreetext extends AdMessageDetailsBase {
    /** @param {{title?:string,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    title;
}
export class AdMessageDetailsTodaysBreakFastOffer extends AdMessageDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdMessageDetailsTodaysLunchOffer extends AdMessageDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdMessageDetailsTodaysDinnerOffer extends AdMessageDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdMessageDetailsSaveFoodAndMoney extends AdMessageDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdMessageDetailsPercentageOffYourFoodBill extends AdMessageDetailsBase {
    /** @param {{percentage?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    percentage;
}
export class AdMessageDetailsHappyHour extends AdMessageDetailsBase {
    /** @param {{description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class AdMessageDetailsSomeFreeTablesLeftToday extends AdMessageDetailsBase {
    /** @param {{description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class AdMessageDetailsTwoDishesForThePriceOfOne extends AdMessageDetailsBase {
    /** @param {{description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class AdMessageDetailsUnion {
    /** @param {{percentageOnAllMerchandise?:AdMessageDetailsPercentageDiscountOnAllMerchandise,percentageRangeOnAllMerchandise?:AdMessageDetailsPercentageDiscountRangeOnAllMerchandise,percentageOnSelectedMerchandise?:AdMessageDetailsPercentageDiscountOnSelectedMerchandise,absoluteOnSelectedMerchandise?:AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise,absoluteRangeOnAllMerchandise?:AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise,totalAmountOverXgivesYdiscount?:AdMessageDetailsTotalAmountOverXgivesYdiscount,xforY?:AdMessageDetailsXforYdiscount,newArrivals?:AdMessageDetailsNewArrivals,freetext?:AdMessageDetailsFreetext,todaysBreakFastOffer?:AdMessageDetailsTodaysBreakFastOffer,todaysLunchOffer?:AdMessageDetailsTodaysLunchOffer,todaysDinnerOffer?:AdMessageDetailsTodaysDinnerOffer,saveFoodAndMoney?:AdMessageDetailsSaveFoodAndMoney,percentageOfYourFoodBill?:AdMessageDetailsPercentageOffYourFoodBill,happyHour?:AdMessageDetailsHappyHour,someFreeTablesLeftToday?:AdMessageDetailsSomeFreeTablesLeftToday,twoDishesForThePriceOfOne?:AdMessageDetailsTwoDishesForThePriceOfOne}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?AdMessageDetailsPercentageDiscountOnAllMerchandise} */
    percentageOnAllMerchandise;
    /** @type {?AdMessageDetailsPercentageDiscountRangeOnAllMerchandise} */
    percentageRangeOnAllMerchandise;
    /** @type {?AdMessageDetailsPercentageDiscountOnSelectedMerchandise} */
    percentageOnSelectedMerchandise;
    /** @type {?AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise} */
    absoluteOnSelectedMerchandise;
    /** @type {?AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise} */
    absoluteRangeOnAllMerchandise;
    /** @type {?AdMessageDetailsTotalAmountOverXgivesYdiscount} */
    totalAmountOverXgivesYdiscount;
    /** @type {?AdMessageDetailsXforYdiscount} */
    xforY;
    /** @type {?AdMessageDetailsNewArrivals} */
    newArrivals;
    /** @type {?AdMessageDetailsFreetext} */
    freetext;
    /** @type {?AdMessageDetailsTodaysBreakFastOffer} */
    todaysBreakFastOffer;
    /** @type {?AdMessageDetailsTodaysLunchOffer} */
    todaysLunchOffer;
    /** @type {?AdMessageDetailsTodaysDinnerOffer} */
    todaysDinnerOffer;
    /** @type {?AdMessageDetailsSaveFoodAndMoney} */
    saveFoodAndMoney;
    /** @type {?AdMessageDetailsPercentageOffYourFoodBill} */
    percentageOfYourFoodBill;
    /** @type {?AdMessageDetailsHappyHour} */
    happyHour;
    /** @type {?AdMessageDetailsSomeFreeTablesLeftToday} */
    someFreeTablesLeftToday;
    /** @type {?AdMessageDetailsTwoDishesForThePriceOfOne} */
    twoDishesForThePriceOfOne;
}

JavaScript GetAdMessageTitleRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"title":"String"}