BusinessApi

CreateAdRequest

Business

**Requires Authentication**
Required role:	Business

The following routes are available for this service:
POST	/ad/create


export module BusinessApi
{
    // @ts-nocheck

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

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

    export class AdDetailsPercentageDiscountOnAllMerchandise extends AdDetailsBase
    {
        public value?: number;

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

    export class AdDetailsPercentageDiscountRangeOnAllMerchandise extends AdDetailsBase
    {
        public start?: number;
        public stop?: number;

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

    export class AdDetailsPercentageDiscountOnSelectedMerchandise extends AdDetailsBase
    {
        public value?: number;

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

    export class AdDetailsAbsoluteDiscountOnSelectedMerchandise extends AdDetailsBase
    {
        public value?: number;

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

    export class AdDetailsAbsoluteDiscountRangeOnAllMerchandise extends AdDetailsBase
    {
        public start?: number;
        public stop?: number;

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

    export class AdDetailsTotalAmountOverXgivesYdiscount extends AdDetailsBase
    {
        public ifTotalAmountMoreThanX?: number;
        public thenYouGetDiscountPercentageY?: number;

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

    export class AdDetailsXforYdiscount extends AdDetailsBase
    {
        public ifYouBuyX?: number;
        public thenYouGetY?: number;

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

    export class AdDetailsNewArrivals extends AdDetailsBase
    {

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

    export class AdDetailsFreetext extends AdDetailsBase
    {
        public title: string;

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

    export class AdDetailsTodaysBreakFastOffer extends AdDetailsBase
    {
        public value?: number;

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

    export class AdDetailsTodaysLunchOffer extends AdDetailsBase
    {
        public value?: number;

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

    export class AdDetailsTodaysDinnerOffer extends AdDetailsBase
    {
        public value?: number;

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

    export class AdDetailsSaveFoodAndMoney extends AdDetailsBase
    {
        public value?: number;

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

    export class AdDetailsPercentageOffYourFoodBill extends AdDetailsBase
    {
        public percentage?: number;

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

    export class AdDetailsHappyHour extends AdDetailsBase
    {

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

    export class AdDetailsSomeFreeTablesLeftToday extends AdDetailsBase
    {

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

    export class AdDetailsTwoDishesForThePriceOfOne extends AdDetailsBase
    {

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

    export class AdDetailsUnion
    {
        public percentageOnAllMerchandise?: AdDetailsPercentageDiscountOnAllMerchandise;
        public percentageRangeOnAllMerchandise?: AdDetailsPercentageDiscountRangeOnAllMerchandise;
        public percentageOnSelectedMerchandise?: AdDetailsPercentageDiscountOnSelectedMerchandise;
        public absoluteOnSelectedMerchandise?: AdDetailsAbsoluteDiscountOnSelectedMerchandise;
        public absoluteRangeOnAllMerchandise?: AdDetailsAbsoluteDiscountRangeOnAllMerchandise;
        public totalAmountOverXgivesYdiscount?: AdDetailsTotalAmountOverXgivesYdiscount;
        public xforY?: AdDetailsXforYdiscount;
        public newArrivals?: AdDetailsNewArrivals;
        public freetext?: AdDetailsFreetext;
        public todaysBreakFastOffer?: AdDetailsTodaysBreakFastOffer;
        public todaysLunchOffer?: AdDetailsTodaysLunchOffer;
        public todaysDinnerOffer?: AdDetailsTodaysDinnerOffer;
        public saveFoodAndMoney?: AdDetailsSaveFoodAndMoney;
        public percentageOfYourFoodBill?: AdDetailsPercentageOffYourFoodBill;
        public happyHour?: AdDetailsHappyHour;
        public someFreeTablesLeftToday?: AdDetailsSomeFreeTablesLeftToday;
        public twoDishesForThePriceOfOne?: AdDetailsTwoDishesForThePriceOfOne;

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

}

TypeScript CreateAdRequest 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.

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

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

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

<CreateAdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Guid>00000000-0000-0000-0000-000000000000</Guid>
  <Id>0</Id>
</CreateAdResponse>