BusinessApi

UpdateAdMessageRequest

Business

**Requires Authentication**
Required role:	Business

The following routes are available for this service:
PUT	/admessage/update


export module BusinessApi
{
    // @ts-nocheck

    export class AdMessageDetailsBase
    {
        public description?: string;
        public moreInformation?: string[] = [];

        public constructor(init?: Partial<AdMessageDetailsBase>) { (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsPercentageDiscountOnAllMerchandise extends AdMessageDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdMessageDetailsPercentageDiscountOnAllMerchandise>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsPercentageDiscountRangeOnAllMerchandise extends AdMessageDetailsBase
    {
        public start?: number;
        public stop?: number;

        public constructor(init?: Partial<AdMessageDetailsPercentageDiscountRangeOnAllMerchandise>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsPercentageDiscountOnSelectedMerchandise extends AdMessageDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdMessageDetailsPercentageDiscountOnSelectedMerchandise>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise extends AdMessageDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise extends AdMessageDetailsBase
    {
        public start?: number;
        public stop?: number;

        public constructor(init?: Partial<AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsTotalAmountOverXgivesYdiscount extends AdMessageDetailsBase
    {
        public ifTotalAmountMoreThanX?: number;
        public thenYouGetDiscountPercentageY?: number;

        public constructor(init?: Partial<AdMessageDetailsTotalAmountOverXgivesYdiscount>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsXforYdiscount extends AdMessageDetailsBase
    {
        public ifYouBuyX?: number;
        public thenYouGetY?: number;

        public constructor(init?: Partial<AdMessageDetailsXforYdiscount>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsNewArrivals extends AdMessageDetailsBase
    {

        public constructor(init?: Partial<AdMessageDetailsNewArrivals>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsFreetext extends AdMessageDetailsBase
    {
        public title: string;

        public constructor(init?: Partial<AdMessageDetailsFreetext>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsTodaysBreakFastOffer extends AdMessageDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdMessageDetailsTodaysBreakFastOffer>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsTodaysLunchOffer extends AdMessageDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdMessageDetailsTodaysLunchOffer>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsTodaysDinnerOffer extends AdMessageDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdMessageDetailsTodaysDinnerOffer>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsSaveFoodAndMoney extends AdMessageDetailsBase
    {
        public value?: number;

        public constructor(init?: Partial<AdMessageDetailsSaveFoodAndMoney>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsPercentageOffYourFoodBill extends AdMessageDetailsBase
    {
        public percentage?: number;

        public constructor(init?: Partial<AdMessageDetailsPercentageOffYourFoodBill>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsHappyHour extends AdMessageDetailsBase
    {

        public constructor(init?: Partial<AdMessageDetailsHappyHour>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsSomeFreeTablesLeftToday extends AdMessageDetailsBase
    {

        public constructor(init?: Partial<AdMessageDetailsSomeFreeTablesLeftToday>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsTwoDishesForThePriceOfOne extends AdMessageDetailsBase
    {

        public constructor(init?: Partial<AdMessageDetailsTwoDishesForThePriceOfOne>) { super(init); (Object as any).assign(this, init); }
    }

    export class AdMessageDetailsUnion
    {
        public percentageOnAllMerchandise?: AdMessageDetailsPercentageDiscountOnAllMerchandise;
        public percentageRangeOnAllMerchandise?: AdMessageDetailsPercentageDiscountRangeOnAllMerchandise;
        public percentageOnSelectedMerchandise?: AdMessageDetailsPercentageDiscountOnSelectedMerchandise;
        public absoluteOnSelectedMerchandise?: AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise;
        public absoluteRangeOnAllMerchandise?: AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise;
        public totalAmountOverXgivesYdiscount?: AdMessageDetailsTotalAmountOverXgivesYdiscount;
        public xforY?: AdMessageDetailsXforYdiscount;
        public newArrivals?: AdMessageDetailsNewArrivals;
        public freetext?: AdMessageDetailsFreetext;
        public todaysBreakFastOffer?: AdMessageDetailsTodaysBreakFastOffer;
        public todaysLunchOffer?: AdMessageDetailsTodaysLunchOffer;
        public todaysDinnerOffer?: AdMessageDetailsTodaysDinnerOffer;
        public saveFoodAndMoney?: AdMessageDetailsSaveFoodAndMoney;
        public percentageOfYourFoodBill?: AdMessageDetailsPercentageOffYourFoodBill;
        public happyHour?: AdMessageDetailsHappyHour;
        public someFreeTablesLeftToday?: AdMessageDetailsSomeFreeTablesLeftToday;
        public twoDishesForThePriceOfOne?: AdMessageDetailsTwoDishesForThePriceOfOne;

        public constructor(init?: Partial<AdMessageDetailsUnion>) { (Object as any).assign(this, init); }
    }

}

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

<UpdateAdMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <AdMessageId>0</AdMessageId>
  <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>
</UpdateAdMessageRequest>

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

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