BusinessApi

<back to all web services

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 .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 /ad/create HTTP/1.1 
Host: qa-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
}