BusinessApi

<back to all web services

CreateAdMessageRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
POST/admessage/create

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 CreateAdMessageRequest DTOs

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.

POST /admessage/create HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	placeId: 0,
	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: text/jsv
Content-Length: length

{
	id: 0
}