BusinessApi

<back to all web services

GetPlaceBootstrapRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/place/getbootstrap
"use strict";
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 {'BarSpeciality'|'BarType'|'Cuisine'|'SaveFoodAndMoney'|'MealType'|'Menu'|'OutdoorSeating'|'Parking'|'PaymentOptions'|'PriceMainDish'|'SubCategories'|'SubCategoriesAndBrands'|'EatingSuitabilities'|'TakeAway'|'WearPriceProfile'|'WheelChairAccessible'|'Wifi'|'WebShop'|'Filtering'} */
export var FeatureType;
(function (FeatureType) {
    FeatureType["BarSpeciality"] = "BarSpeciality"
    FeatureType["BarType"] = "BarType"
    FeatureType["Cuisine"] = "Cuisine"
    FeatureType["SaveFoodAndMoney"] = "SaveFoodAndMoney"
    FeatureType["MealType"] = "MealType"
    FeatureType["Menu"] = "Menu"
    FeatureType["OutdoorSeating"] = "OutdoorSeating"
    FeatureType["Parking"] = "Parking"
    FeatureType["PaymentOptions"] = "PaymentOptions"
    FeatureType["PriceMainDish"] = "PriceMainDish"
    FeatureType["SubCategories"] = "SubCategories"
    FeatureType["SubCategoriesAndBrands"] = "SubCategoriesAndBrands"
    FeatureType["EatingSuitabilities"] = "EatingSuitabilities"
    FeatureType["TakeAway"] = "TakeAway"
    FeatureType["WearPriceProfile"] = "WearPriceProfile"
    FeatureType["WheelChairAccessible"] = "WheelChairAccessible"
    FeatureType["Wifi"] = "Wifi"
    FeatureType["WebShop"] = "WebShop"
    FeatureType["Filtering"] = "Filtering"
})(FeatureType || (FeatureType = {}));
export class BarSpecialityDto {
    /** @param {{id?:number,slug?:string,title?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    id;
    /** @type {string} */
    slug;
    /** @type {string} */
    title;
}
export class BarTypeDto {
    /** @param {{id?:number,slug?:string,title?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    id;
    /** @type {string} */
    slug;
    /** @type {string} */
    title;
}
export class CuisineDto {
    /** @param {{id?:number,label?:string,slug?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    id;
    /** @type {string} */
    label;
    /** @type {string} */
    slug;
}
/** @typedef {'StreetParking'|'ParkingGarageNearby'} */
export var Parking;
(function (Parking) {
    Parking["StreetParking"] = "StreetParking"
    Parking["ParkingGarageNearby"] = "ParkingGarageNearby"
})(Parking || (Parking = {}));
/** @typedef {'Visa'|'MasterCard'|'AmericanExpress'|'Diners'|'Vipps'} */
export var PaymentOption;
(function (PaymentOption) {
    PaymentOption["Visa"] = "Visa"
    PaymentOption["MasterCard"] = "MasterCard"
    PaymentOption["AmericanExpress"] = "AmericanExpress"
    PaymentOption["Diners"] = "Diners"
    PaymentOption["Vipps"] = "Vipps"
})(PaymentOption || (PaymentOption = {}));
export class EatingSuitability {
    /** @param {{id?:number,label?:string,slug?:string,position?:number,createdAt?:string,updatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    id;
    /** @type {?string} */
    label;
    /** @type {?string} */
    slug;
    /** @type {?number} */
    position;
    /** @type {?string} */
    createdAt;
    /** @type {?string} */
    updatedAt;
}
/** @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;
}
/** @typedef {'Owner'|'Manager'|'Sales'|'Marketing'|'Other'} */
export var BusinessRole;
(function (BusinessRole) {
    BusinessRole["Owner"] = "Owner"
    BusinessRole["Manager"] = "Manager"
    BusinessRole["Sales"] = "Sales"
    BusinessRole["Marketing"] = "Marketing"
    BusinessRole["Other"] = "Other"
})(BusinessRole || (BusinessRole = {}));

JavaScript GetPlaceBootstrapRequest 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 /place/getbootstrap HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	getPlaceResponse: 
	{
		place: 
		{
			id: 0,
			name: String,
			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
					}
				}
			},
			featureData: 
			[
				{
					slug: BarSpeciality,
					label: String
				}
			],
			categories: 
			[
				{
					id: 0,
					slug: String,
					absoluteSlug: String,
					name: String,
					children: 
					[
						{
							id: 0,
							slug: String,
							absoluteSlug: String,
							name: String,
							children: 
							[
								{
									id: 0,
									slug: String,
									absoluteSlug: String,
									name: String,
									featureTypes: 
									[
										{
											slug: BarSpeciality,
											label: String
										}
									]
								}
							],
							featureTypes: 
							[
								{
									slug: BarSpeciality,
									label: String
								}
							]
						}
					],
					featureTypes: 
					[
						{
							slug: BarSpeciality,
							label: String
						}
					]
				}
			],
			rootCategory: 
			{
				id: 0,
				slug: String,
				absoluteSlug: String,
				name: String,
				parentId: 0
			},
			menus: 
			[
				{
					id: 0,
					name: String,
					url: String,
					position: 0
				}
			],
			barSpecialities: 
			[
				{
					id: 0,
					slug: String,
					title: String
				}
			],
			barTypes: 
			[
				{
					id: 0,
					slug: String,
					title: String
				}
			],
			brands: 
			[
				{
					id: 0,
					brand: 
					{
						id: 0,
						definedByRootCategoryId: 0,
						name: String
					},
					category: 
					{
						id: 0,
						slug: String,
						absoluteSlug: String,
						name: String,
						parentId: 0
					},
					placeCustomBrand: 
					{
						id: 0,
						definedByPlaceId: 0,
						name: String
					}
				}
			],
			cuisines: 
			[
				{
					id: 0,
					label: String,
					slug: String
				}
			],
			mealTypes: 
			[
				{
					id: 0,
					label: String,
					slug: String,
					position: 0
				}
			],
			parking: 
			[
				{
					label: String,
					slug: StreetParking
				}
			],
			paymentOptions: 
			[
				{
					label: String,
					slug: Visa
				}
			],
			eatingSuitabilities: 
			[
				{
					label: String,
					slug: 
					{
						id: 0,
						label: String,
						slug: String,
						position: 0,
						createdAt: 0001-01-01T00:00:00.0000000+00:00,
						updatedAt: 0001-01-01T00:00:00.0000000+00:00
					}
				}
			],
			takeAways: 
			[
				{
					id: 0,
					label: String,
					slug: String,
					position: 0
				}
			],
			wearPriceProfiles: 
			[
				{
					id: 0,
					label: String,
					slug: String
				}
			],
			wheelChairAccessible: False,
			wifi: False,
			outdoorSeating: False,
			saveFoodAndMoney: False,
			logoUrl: String,
			customImageUrl: String,
			categoryImageUrl: String,
			placeType: Mall,
			places: 
			[
				{
					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
				}
			],
			otherServices: 
			[
				{
					id: 0,
					serviceName: String,
					floor: String
				}
			],
			mall: 
			{
				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
			},
			floor: String,
			timeZoneDto: 
			{
				baseUtcOffset: PT0S,
				daylightName: String,
				displayName: String,
				id: String,
				standardName: String,
				supportsDaylightSavingTime: False
			},
			businessId: 0,
			contact: 
			{
				phone: String,
				email: String,
				website: String,
				webShop: String
			},
			address: 
			{
				street: String,
				postalCode: String,
				region: String,
				countryCode: String
			},
			priceMainDish: 
			{
				title: String,
				slug: Value
			}
		}
	},
	getStaffUserResponse: 
	{
		staffDto: 
		{
			id: 0,
			firstName: String,
			lastName: String,
			email: String,
			role: Owner,
			placeId: 0,
			businessId: 0,
			userId: 0,
			placeName: String,
			businessName: String,
			mobileNumber: String,
			businessRole: Owner,
			lastActiveOn: 0001-01-01T00:00:00.0000000+00:00
		}
	},
	getPlaceCountersResponse: 
	{
		adMessagesDraftCount: 0,
		adMessagesUpcomingCount: 0,
		adMessagesRunningCount: 0
	},
	thisIsTheLastOwnerAndDeleteWillUnclaimThePlace: False
}