| Required role: | Business |
| GET | /admessage/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 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 GetAdMessagesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /admessage/get_all HTTP/1.1 Host: business-api.brovs.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
adMessagesWithVisibilityState:
[
{
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
]
}
}
}
]
}