BusinessApi

<back to all web services

GetAdsRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/ad/get_all

export module BusinessApi
{
    // @ts-nocheck

    export enum VisibilityState
    {
        Draft = 'Draft',
        Running = 'Running',
        Upcoming = 'Upcoming',
        Archived = 'Archived',
        Paused = 'Paused',
    }

    export class ImageUrls
    {
        public preview: string;
        public small: string;
        public medium: string;
        public large: string;

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

    export class OpeningHour
    {
        public openAtHour?: number;
        public openAtMinute?: number;
        public closeAtHour?: number;
        public closeAtMinute?: number;

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

    export class WeeklyOpeningHours
    {
        public monday?: OpeningHour;
        public tuesday?: OpeningHour;
        public wednesday?: OpeningHour;
        public thursday?: OpeningHour;
        public friday?: OpeningHour;
        public saturday?: OpeningHour;
        public sunday?: OpeningHour;

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

    export class OpeningHours
    {
        public weekly: WeeklyOpeningHours;

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

    export enum PlaceType
    {
        Mall = 'Mall',
        Regular = 'Regular',
    }

    export class PlaceContact
    {
        public phone?: string;
        public email?: string;
        public website?: string;
        public webShop?: string;

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

    export class PlaceAddress
    {
        public street: string;
        public postalCode: string;
        public region: string;
        public countryCode: string;

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

    export class TimeZoneDto
    {
        public baseUtcOffset?: string;
        public daylightName: string;
        public displayName: string;
        public id: string;
        public standardName: string;
        public supportsDaylightSavingTime?: boolean;

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

    export enum PriceMainDish
    {
        Value = 'Value',
        Medium = 'Medium',
        High = 'High',
        FineDining = 'FineDining',
    }

    export class PriceMainDishDto
    {
        public title: string;
        public slug?: PriceMainDish;

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

    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 GetAdsRequest 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.

GET /ad/get_all HTTP/1.1 
Host: qa-business-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	adsWithVisibilityState: 
	[
		{
			id: 0,
			title: String,
			startAt: 
			{
				year: 0,
				month: 0,
				day: 0,
				hour: 0,
				minute: 0,
				second: 0
			},
			stopAt: 
			{
				year: 0,
				month: 0,
				day: 0,
				hour: 0,
				minute: 0,
				second: 0
			},
			publishAt: 
			{
				year: 0,
				month: 0,
				day: 0,
				hour: 0,
				minute: 0,
				second: 0
			},
			state: String,
			updatedAt: 0001-01-01T00:00:00.0000000+00:00,
			imageUrls: 
			[
				{
					preview: String,
					small: String,
					medium: String,
					large: String
				}
			],
			place: 
			{
				id: 0,
				name: String,
				businessId: 0,
				longitude: 0,
				latitude: 0,
				claimed: False,
				organizationNumber: String,
				countryCode: String,
				overview: String,
				openingHours: 
				{
					weekly: 
					{
						monday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						},
						tuesday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						},
						wednesday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						},
						thursday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						},
						friday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						},
						saturday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						},
						sunday: 
						{
							openAtHour: 0,
							openAtMinute: 0,
							closeAtHour: 0,
							closeAtMinute: 0
						}
					}
				},
				placeType: Mall,
				contact: 
				{
					phone: String,
					email: String,
					website: String,
					webShop: String
				},
				address: 
				{
					street: String,
					postalCode: String,
					region: String,
					countryCode: String
				},
				wheelChairAccessible: False,
				wifi: False,
				outdoorSeating: False,
				saveFoodAndMoney: False,
				timeZoneDto: 
				{
					baseUtcOffset: PT0S,
					daylightName: String,
					displayName: String,
					id: String,
					standardName: String,
					supportsDaylightSavingTime: False
				},
				priceMainDish: 
				{
					title: String,
					slug: Value
				},
				otherServices: 
				[
					{
						id: 0,
						serviceName: String,
						floor: String
					}
				],
				floor: String
			},
			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
					]
				}
			}
		}
	]
}