BusinessApi

<back to all web services

GetPlaceBootstrapRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/place/getbootstrap
GetPlaceBootstrapRequest Parameters:
NameParameterData TypeRequiredDescription
PlaceIdquerylongNo
GetPlaceBootstrapResponse Parameters:
NameParameterData TypeRequiredDescription
GetPlaceResponseformGetPlaceResponseYes
GetStaffUserResponseformGetStaffUserResponseYes
GetPlaceCountersResponseformGetPlaceCountersResponseYes
ThisIsTheLastOwnerAndDeleteWillUnclaimThePlaceformboolNo
GetPlaceResponse Parameters:
NameParameterData TypeRequiredDescription
PlaceformPlaceDtoYes
PlaceDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
GuidformGuidNo
NameformstringYes
Longitudeformfloat?No
Latitudeformfloat?No
ClaimedformboolNo
OrganizationNumberformstringNo
CountryCodeformstringYes
OverviewformstringNo
OpeningHoursformOpeningHoursNo
FeatureDataformList<FeatureDto>Yes
CategoriesformList<CategoryTreeWithFeaturesDto>Yes
RootCategoryformCategoryDtoNo
MenusformList<BusinessMenuDto>Yes
BarSpecialitiesformList<BarSpecialityDto>Yes
BarTypesformList<BarTypeDto>Yes
BrandsformList<PlaceSelectedBrandDto>Yes
CuisinesformList<CuisineDto>Yes
MealTypesformList<MealTypeDto>Yes
ParkingformList<ParkingDto>Yes
PaymentOptionsformList<PaymentOptionDto>Yes
EatingSuitabilitiesformList<EatingSuitabilityDto>Yes
TakeAwaysformList<TakeAwayDto>Yes
WearPriceProfilesformList<BusinessWearPriceProfileDto>Yes
WheelChairAccessibleformbool?No
Wififormbool?No
OutdoorSeatingformbool?No
SaveFoodAndMoneyformbool?No
LogoUrlformstringNo
CustomImageUrlformstringNo
CategoryImageUrlformstringNo
PlaceTypeformPlaceTypeNo
PlacesformList<PlaceBasicDto>No
OtherServicesformList<MallOtherServiceDto>No
MallformPlaceBasicDtoNo
FloorformstringNo
TimeZoneDtoformTimeZoneDtoYes
BusinessIdformlong?No
ContactformPlaceContactYes
AddressformPlaceAddressYes
PriceMainDishformPriceMainDishDtoNo
OpeningHours Parameters:
NameParameterData TypeRequiredDescription
WeeklyformWeeklyOpeningHoursYes
WeeklyOpeningHours Parameters:
NameParameterData TypeRequiredDescription
MondayformOpeningHourNo
TuesdayformOpeningHourNo
WednesdayformOpeningHourNo
ThursdayformOpeningHourNo
FridayformOpeningHourNo
SaturdayformOpeningHourNo
SundayformOpeningHourNo
OpeningHour Parameters:
NameParameterData TypeRequiredDescription
OpenAtHourformintNo
OpenAtMinuteformintNo
CloseAtHourformintNo
CloseAtMinuteformintNo
FeatureDto Parameters:
NameParameterData TypeRequiredDescription
SlugformFeatureTypeNo
LabelformstringYes
FeatureType Enum:
BarSpeciality
BarType
Cuisine
SaveFoodAndMoney
MealType
Menu
OutdoorSeating
Parking
PaymentOptions
PriceMainDish
SubCategories
SubCategoriesAndBrands
EatingSuitabilities
TakeAway
WearPriceProfile
WheelChairAccessible
Wifi
WebShop
Filtering
CategoryTreeWithFeaturesDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SlugformstringYes
AbsoluteSlugformstringYes
NameformstringYes
ChildrenformList<CategoryTreeWithFeaturesDto>No
FeatureTypesformList<FeatureDto>No
CategoryDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SlugformstringYes
AbsoluteSlugformstringYes
NameformstringYes
ParentIdformlong?No
BusinessMenuDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringYes
UrlformstringYes
PositionformintNo
BarSpecialityDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SlugformstringYes
TitleformstringYes
BarTypeDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SlugformstringYes
TitleformstringYes
PlaceSelectedBrandDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
BrandformBrandDtoNo
CategoryformCategoryDtoNo
PlaceCustomBrandformPlaceCustomBrandDtoNo
BrandDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DefinedByRootCategoryIdformlongNo
NameformstringYes
PlaceCustomBrandDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DefinedByPlaceIdformlongNo
NameformstringYes
CuisineDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
LabelformstringYes
SlugformstringYes
MealTypeDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
LabelformstringYes
SlugformstringYes
PositionformintNo
ParkingDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformParkingNo
Parking Enum:
StreetParking
ParkingGarageNearby
PaymentOptionDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformPaymentOptionNo
PaymentOption Enum:
Visa
MasterCard
AmericanExpress
Diners
Vipps
EatingSuitabilityDto Parameters:
NameParameterData TypeRequiredDescription
LabelformstringYes
SlugformEatingSuitabilityYes
EatingSuitability Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
LabelformstringNo
SlugformstringNo
PositionformintNo
CreatedAtformDateTimeOffsetNo
UpdatedAtformDateTimeOffsetNo
TakeAwayDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
LabelformstringYes
SlugformstringYes
PositionformintNo
BusinessWearPriceProfileDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
LabelformstringYes
SlugformstringYes
PlaceType Enum:
Mall
Regular
PlaceBasicDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
GuidformGuidNo
NameformstringYes
BusinessIdformlong?No
Longitudeformfloat?No
Latitudeformfloat?No
ClaimedformboolNo
OrganizationNumberformstringNo
CountryCodeformstringYes
OverviewformstringNo
OpeningHoursformOpeningHoursNo
PlaceTypeformPlaceTypeNo
ContactformPlaceContactYes
AddressformPlaceAddressYes
WheelChairAccessibleformbool?No
Wififormbool?No
OutdoorSeatingformbool?No
SaveFoodAndMoneyformbool?No
TimeZoneDtoformTimeZoneDtoYes
PriceMainDishformPriceMainDishDtoNo
OtherServicesformList<MallOtherServiceDto>No
FloorformstringNo
PlaceContact Parameters:
NameParameterData TypeRequiredDescription
PhoneformstringNo
EmailformstringNo
WebsiteformstringNo
WebShopformstringNo
PlaceAddress Parameters:
NameParameterData TypeRequiredDescription
StreetformstringYes
PostalCodeformstringYes
RegionformstringYes
CountryCodeformstringYes
TimeZoneDto Parameters:
NameParameterData TypeRequiredDescription
BaseUtcOffsetformTimeSpanNo
DaylightNameformstringYes
DisplayNameformstringYes
IdformstringYes
StandardNameformstringYes
SupportsDaylightSavingTimeformboolNo
PriceMainDishDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes
SlugformPriceMainDishNo
PriceMainDish Enum:
Value
Medium
High
FineDining
MallOtherServiceDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ServiceNameformstringYes
FloorformstringYes
GetStaffUserResponse Parameters:
NameParameterData TypeRequiredDescription
StaffDtoformStaffDtoYes
StaffDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
RoleformStaffRoleNo
PlaceIdformlong?No
BusinessIdformlong?No
UserIdformlongNo
PlaceNameformstringNo
BusinessNameformstringNo
MobileNumberformstringYes
BusinessRoleformBusinessRoleNo
LastActiveOnformDateTimeOffsetNo
StaffRole Enum:
Owner
Admin
Regular
BusinessRole Enum:
Owner
Manager
Sales
Marketing
Other
GetPlaceCountersResponse Parameters:
NameParameterData TypeRequiredDescription
AdMessagesDraftCountformlongNo
AdMessagesUpcomingCountformlongNo
AdMessagesRunningCountformlongNo

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
}