| Required role: | Business |
| GET | /admessage/get_all |
|---|
"use strict";
/** @typedef {'Draft'|'Running'|'Upcoming'|'Archived'|'Paused'} */
export var VisibilityState;
(function (VisibilityState) {
VisibilityState["Draft"] = "Draft"
VisibilityState["Running"] = "Running"
VisibilityState["Upcoming"] = "Upcoming"
VisibilityState["Archived"] = "Archived"
VisibilityState["Paused"] = "Paused"
})(VisibilityState || (VisibilityState = {}));
export class ImageUrls {
/** @param {{preview?:string,small?:string,medium?:string,large?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
preview;
/** @type {string} */
small;
/** @type {string} */
medium;
/** @type {string} */
large;
}
export class OpeningHour {
/** @param {{openAtHour?:number,openAtMinute?:number,closeAtHour?:number,closeAtMinute?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
openAtHour;
/** @type {?number} */
openAtMinute;
/** @type {?number} */
closeAtHour;
/** @type {?number} */
closeAtMinute;
}
export class WeeklyOpeningHours {
/** @param {{monday?:OpeningHour,tuesday?:OpeningHour,wednesday?:OpeningHour,thursday?:OpeningHour,friday?:OpeningHour,saturday?:OpeningHour,sunday?:OpeningHour}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?OpeningHour} */
monday;
/** @type {?OpeningHour} */
tuesday;
/** @type {?OpeningHour} */
wednesday;
/** @type {?OpeningHour} */
thursday;
/** @type {?OpeningHour} */
friday;
/** @type {?OpeningHour} */
saturday;
/** @type {?OpeningHour} */
sunday;
}
export class OpeningHours {
/** @param {{weekly?:WeeklyOpeningHours}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {WeeklyOpeningHours} */
weekly;
}
/** @typedef {'Mall'|'Regular'} */
export var PlaceType;
(function (PlaceType) {
PlaceType["Mall"] = "Mall"
PlaceType["Regular"] = "Regular"
})(PlaceType || (PlaceType = {}));
export class PlaceContact {
/** @param {{phone?:string,email?:string,website?:string,webShop?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
phone;
/** @type {?string} */
email;
/** @type {?string} */
website;
/** @type {?string} */
webShop;
}
export class PlaceAddress {
/** @param {{street?:string,postalCode?:string,region?:string,countryCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
street;
/** @type {string} */
postalCode;
/** @type {string} */
region;
/** @type {string} */
countryCode;
}
export class TimeZoneDto {
/** @param {{baseUtcOffset?:string,daylightName?:string,displayName?:string,id?:string,standardName?:string,supportsDaylightSavingTime?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
baseUtcOffset;
/** @type {string} */
daylightName;
/** @type {string} */
displayName;
/** @type {string} */
id;
/** @type {string} */
standardName;
/** @type {?boolean} */
supportsDaylightSavingTime;
}
/** @typedef {'Value'|'Medium'|'High'|'FineDining'} */
export var PriceMainDish;
(function (PriceMainDish) {
PriceMainDish["Value"] = "Value"
PriceMainDish["Medium"] = "Medium"
PriceMainDish["High"] = "High"
PriceMainDish["FineDining"] = "FineDining"
})(PriceMainDish || (PriceMainDish = {}));
export class PriceMainDishDto {
/** @param {{title?:string,slug?:PriceMainDish}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
title;
/** @type {?PriceMainDish} */
slug;
}
export class AdMessageDetailsBase {
/** @param {{description?:string,moreInformation?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
description;
/** @type {?string[]} */
moreInformation = [];
}
export class AdMessageDetailsPercentageDiscountOnAllMerchandise extends AdMessageDetailsBase {
/** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
value;
}
export class AdMessageDetailsPercentageDiscountRangeOnAllMerchandise extends AdMessageDetailsBase {
/** @param {{start?:number,stop?:number,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
start;
/** @type {?number} */
stop;
}
export class AdMessageDetailsPercentageDiscountOnSelectedMerchandise extends AdMessageDetailsBase {
/** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
value;
}
export class AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise extends AdMessageDetailsBase {
/** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
value;
}
export class AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise extends AdMessageDetailsBase {
/** @param {{start?:number,stop?:number,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
start;
/** @type {?number} */
stop;
}
export class AdMessageDetailsTotalAmountOverXgivesYdiscount extends AdMessageDetailsBase {
/** @param {{ifTotalAmountMoreThanX?:number,thenYouGetDiscountPercentageY?:number,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
ifTotalAmountMoreThanX;
/** @type {?number} */
thenYouGetDiscountPercentageY;
}
export class AdMessageDetailsXforYdiscount extends AdMessageDetailsBase {
/** @param {{ifYouBuyX?:number,thenYouGetY?:number,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
ifYouBuyX;
/** @type {?number} */
thenYouGetY;
}
export class AdMessageDetailsNewArrivals extends AdMessageDetailsBase {
/** @param {{description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class AdMessageDetailsFreetext extends AdMessageDetailsBase {
/** @param {{title?:string,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
title;
}
export class AdMessageDetailsTodaysBreakFastOffer extends AdMessageDetailsBase {
/** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
value;
}
export class AdMessageDetailsTodaysLunchOffer extends AdMessageDetailsBase {
/** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
value;
}
export class AdMessageDetailsTodaysDinnerOffer extends AdMessageDetailsBase {
/** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
value;
}
export class AdMessageDetailsSaveFoodAndMoney extends AdMessageDetailsBase {
/** @param {{value?:number,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
value;
}
export class AdMessageDetailsPercentageOffYourFoodBill extends AdMessageDetailsBase {
/** @param {{percentage?:number,description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
percentage;
}
export class AdMessageDetailsHappyHour extends AdMessageDetailsBase {
/** @param {{description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class AdMessageDetailsSomeFreeTablesLeftToday extends AdMessageDetailsBase {
/** @param {{description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class AdMessageDetailsTwoDishesForThePriceOfOne extends AdMessageDetailsBase {
/** @param {{description?:string,moreInformation?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class AdMessageDetailsUnion {
/** @param {{percentageOnAllMerchandise?:AdMessageDetailsPercentageDiscountOnAllMerchandise,percentageRangeOnAllMerchandise?:AdMessageDetailsPercentageDiscountRangeOnAllMerchandise,percentageOnSelectedMerchandise?:AdMessageDetailsPercentageDiscountOnSelectedMerchandise,absoluteOnSelectedMerchandise?:AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise,absoluteRangeOnAllMerchandise?:AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise,totalAmountOverXgivesYdiscount?:AdMessageDetailsTotalAmountOverXgivesYdiscount,xforY?:AdMessageDetailsXforYdiscount,newArrivals?:AdMessageDetailsNewArrivals,freetext?:AdMessageDetailsFreetext,todaysBreakFastOffer?:AdMessageDetailsTodaysBreakFastOffer,todaysLunchOffer?:AdMessageDetailsTodaysLunchOffer,todaysDinnerOffer?:AdMessageDetailsTodaysDinnerOffer,saveFoodAndMoney?:AdMessageDetailsSaveFoodAndMoney,percentageOfYourFoodBill?:AdMessageDetailsPercentageOffYourFoodBill,happyHour?:AdMessageDetailsHappyHour,someFreeTablesLeftToday?:AdMessageDetailsSomeFreeTablesLeftToday,twoDishesForThePriceOfOne?:AdMessageDetailsTwoDishesForThePriceOfOne}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?AdMessageDetailsPercentageDiscountOnAllMerchandise} */
percentageOnAllMerchandise;
/** @type {?AdMessageDetailsPercentageDiscountRangeOnAllMerchandise} */
percentageRangeOnAllMerchandise;
/** @type {?AdMessageDetailsPercentageDiscountOnSelectedMerchandise} */
percentageOnSelectedMerchandise;
/** @type {?AdMessageDetailsAbsoluteDiscountOnSelectedMerchandise} */
absoluteOnSelectedMerchandise;
/** @type {?AdMessageDetailsAbsoluteDiscountRangeOnAllMerchandise} */
absoluteRangeOnAllMerchandise;
/** @type {?AdMessageDetailsTotalAmountOverXgivesYdiscount} */
totalAmountOverXgivesYdiscount;
/** @type {?AdMessageDetailsXforYdiscount} */
xforY;
/** @type {?AdMessageDetailsNewArrivals} */
newArrivals;
/** @type {?AdMessageDetailsFreetext} */
freetext;
/** @type {?AdMessageDetailsTodaysBreakFastOffer} */
todaysBreakFastOffer;
/** @type {?AdMessageDetailsTodaysLunchOffer} */
todaysLunchOffer;
/** @type {?AdMessageDetailsTodaysDinnerOffer} */
todaysDinnerOffer;
/** @type {?AdMessageDetailsSaveFoodAndMoney} */
saveFoodAndMoney;
/** @type {?AdMessageDetailsPercentageOffYourFoodBill} */
percentageOfYourFoodBill;
/** @type {?AdMessageDetailsHappyHour} */
happyHour;
/** @type {?AdMessageDetailsSomeFreeTablesLeftToday} */
someFreeTablesLeftToday;
/** @type {?AdMessageDetailsTwoDishesForThePriceOfOne} */
twoDishesForThePriceOfOne;
}
JavaScript GetAdMessagesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"]}}}]}