BusinessApi

<back to all web services

UpdateAdRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
PUT/ad/update
"use strict";
export class AdDetailsBase {
    /** @param {{description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    description;
    /** @type {?string[]} */
    moreInformation = [];
}
export class AdDetailsPercentageDiscountOnAllMerchandise extends AdDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdDetailsPercentageDiscountRangeOnAllMerchandise extends AdDetailsBase {
    /** @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 AdDetailsPercentageDiscountOnSelectedMerchandise extends AdDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdDetailsAbsoluteDiscountOnSelectedMerchandise extends AdDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdDetailsAbsoluteDiscountRangeOnAllMerchandise extends AdDetailsBase {
    /** @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 AdDetailsTotalAmountOverXgivesYdiscount extends AdDetailsBase {
    /** @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 AdDetailsXforYdiscount extends AdDetailsBase {
    /** @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 AdDetailsNewArrivals extends AdDetailsBase {
    /** @param {{description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class AdDetailsFreetext extends AdDetailsBase {
    /** @param {{title?:string,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    title;
}
export class AdDetailsTodaysBreakFastOffer extends AdDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdDetailsTodaysLunchOffer extends AdDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdDetailsTodaysDinnerOffer extends AdDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdDetailsSaveFoodAndMoney extends AdDetailsBase {
    /** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    value;
}
export class AdDetailsPercentageOffYourFoodBill extends AdDetailsBase {
    /** @param {{percentage?:number,description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    percentage;
}
export class AdDetailsHappyHour extends AdDetailsBase {
    /** @param {{description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class AdDetailsSomeFreeTablesLeftToday extends AdDetailsBase {
    /** @param {{description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class AdDetailsTwoDishesForThePriceOfOne extends AdDetailsBase {
    /** @param {{description?:string,moreInformation?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class AdDetailsUnion {
    /** @param {{percentageOnAllMerchandise?:AdDetailsPercentageDiscountOnAllMerchandise,percentageRangeOnAllMerchandise?:AdDetailsPercentageDiscountRangeOnAllMerchandise,percentageOnSelectedMerchandise?:AdDetailsPercentageDiscountOnSelectedMerchandise,absoluteOnSelectedMerchandise?:AdDetailsAbsoluteDiscountOnSelectedMerchandise,absoluteRangeOnAllMerchandise?:AdDetailsAbsoluteDiscountRangeOnAllMerchandise,totalAmountOverXgivesYdiscount?:AdDetailsTotalAmountOverXgivesYdiscount,xforY?:AdDetailsXforYdiscount,newArrivals?:AdDetailsNewArrivals,freetext?:AdDetailsFreetext,todaysBreakFastOffer?:AdDetailsTodaysBreakFastOffer,todaysLunchOffer?:AdDetailsTodaysLunchOffer,todaysDinnerOffer?:AdDetailsTodaysDinnerOffer,saveFoodAndMoney?:AdDetailsSaveFoodAndMoney,percentageOfYourFoodBill?:AdDetailsPercentageOffYourFoodBill,happyHour?:AdDetailsHappyHour,someFreeTablesLeftToday?:AdDetailsSomeFreeTablesLeftToday,twoDishesForThePriceOfOne?:AdDetailsTwoDishesForThePriceOfOne}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?AdDetailsPercentageDiscountOnAllMerchandise} */
    percentageOnAllMerchandise;
    /** @type {?AdDetailsPercentageDiscountRangeOnAllMerchandise} */
    percentageRangeOnAllMerchandise;
    /** @type {?AdDetailsPercentageDiscountOnSelectedMerchandise} */
    percentageOnSelectedMerchandise;
    /** @type {?AdDetailsAbsoluteDiscountOnSelectedMerchandise} */
    absoluteOnSelectedMerchandise;
    /** @type {?AdDetailsAbsoluteDiscountRangeOnAllMerchandise} */
    absoluteRangeOnAllMerchandise;
    /** @type {?AdDetailsTotalAmountOverXgivesYdiscount} */
    totalAmountOverXgivesYdiscount;
    /** @type {?AdDetailsXforYdiscount} */
    xforY;
    /** @type {?AdDetailsNewArrivals} */
    newArrivals;
    /** @type {?AdDetailsFreetext} */
    freetext;
    /** @type {?AdDetailsTodaysBreakFastOffer} */
    todaysBreakFastOffer;
    /** @type {?AdDetailsTodaysLunchOffer} */
    todaysLunchOffer;
    /** @type {?AdDetailsTodaysDinnerOffer} */
    todaysDinnerOffer;
    /** @type {?AdDetailsSaveFoodAndMoney} */
    saveFoodAndMoney;
    /** @type {?AdDetailsPercentageOffYourFoodBill} */
    percentageOfYourFoodBill;
    /** @type {?AdDetailsHappyHour} */
    happyHour;
    /** @type {?AdDetailsSomeFreeTablesLeftToday} */
    someFreeTablesLeftToday;
    /** @type {?AdDetailsTwoDishesForThePriceOfOne} */
    twoDishesForThePriceOfOne;
}

JavaScript UpdateAdRequest 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.

PUT /ad/update HTTP/1.1 
Host: qa-business-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateAdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <AdId>0</AdId>
  <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>
  <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>
  <StopAt>
    <Day>0</Day>
    <Hour>0</Hour>
    <Minute>0</Minute>
    <Month>0</Month>
    <Second>0</Second>
    <Year>0</Year>
  </StopAt>
</UpdateAdRequest>

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

<UpdateAdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <AdId>0</AdId>
</UpdateAdResponse>