BusinessApi

<back to all web services

GetPlaceBootstrapRequest

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

export module BusinessApi
{
    // @ts-nocheck

    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 FeatureType
    {
        BarSpeciality = 'BarSpeciality',
        BarType = 'BarType',
        Cuisine = 'Cuisine',
        SaveFoodAndMoney = 'SaveFoodAndMoney',
        MealType = 'MealType',
        Menu = 'Menu',
        OutdoorSeating = 'OutdoorSeating',
        Parking = 'Parking',
        PaymentOptions = 'PaymentOptions',
        PriceMainDish = 'PriceMainDish',
        SubCategories = 'SubCategories',
        SubCategoriesAndBrands = 'SubCategoriesAndBrands',
        EatingSuitabilities = 'EatingSuitabilities',
        TakeAway = 'TakeAway',
        WearPriceProfile = 'WearPriceProfile',
        WheelChairAccessible = 'WheelChairAccessible',
        Wifi = 'Wifi',
        WebShop = 'WebShop',
        Filtering = 'Filtering',
    }

    export class BarSpecialityDto
    {
        public id?: number;
        public slug: string;
        public title: string;

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

    export class BarTypeDto
    {
        public id?: number;
        public slug: string;
        public title: string;

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

    export class CuisineDto
    {
        public id?: number;
        public label: string;
        public slug: string;

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

    export enum Parking
    {
        StreetParking = 'StreetParking',
        ParkingGarageNearby = 'ParkingGarageNearby',
    }

    export enum PaymentOption
    {
        Visa = 'Visa',
        MasterCard = 'MasterCard',
        AmericanExpress = 'AmericanExpress',
        Diners = 'Diners',
        Vipps = 'Vipps',
    }

    export class EatingSuitability implements IAudit
    {
        public id?: number;
        public label?: string;
        public slug?: string;
        public position?: number;
        public createdAt?: string;
        public updatedAt?: string;

        public constructor(init?: Partial<EatingSuitability>) { (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 enum BusinessRole
    {
        Owner = 'Owner',
        Manager = 'Manager',
        Sales = 'Sales',
        Marketing = 'Marketing',
        Other = 'Other',
    }

}

TypeScript 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
}