BusinessApi

<back to all web services

GetPlaceRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/place/get
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class BusinessApi
{

    public static class OpeningHours
    {
        public WeeklyOpeningHours weekly = null;
        
        public WeeklyOpeningHours getWeekly() { return weekly; }
        public OpeningHours setWeekly(WeeklyOpeningHours value) { this.weekly = value; return this; }
    }

    public static class WeeklyOpeningHours
    {
        public OpeningHour monday = null;
        public OpeningHour tuesday = null;
        public OpeningHour wednesday = null;
        public OpeningHour thursday = null;
        public OpeningHour friday = null;
        public OpeningHour saturday = null;
        public OpeningHour sunday = null;
        
        public OpeningHour getMonday() { return monday; }
        public WeeklyOpeningHours setMonday(OpeningHour value) { this.monday = value; return this; }
        public OpeningHour getTuesday() { return tuesday; }
        public WeeklyOpeningHours setTuesday(OpeningHour value) { this.tuesday = value; return this; }
        public OpeningHour getWednesday() { return wednesday; }
        public WeeklyOpeningHours setWednesday(OpeningHour value) { this.wednesday = value; return this; }
        public OpeningHour getThursday() { return thursday; }
        public WeeklyOpeningHours setThursday(OpeningHour value) { this.thursday = value; return this; }
        public OpeningHour getFriday() { return friday; }
        public WeeklyOpeningHours setFriday(OpeningHour value) { this.friday = value; return this; }
        public OpeningHour getSaturday() { return saturday; }
        public WeeklyOpeningHours setSaturday(OpeningHour value) { this.saturday = value; return this; }
        public OpeningHour getSunday() { return sunday; }
        public WeeklyOpeningHours setSunday(OpeningHour value) { this.sunday = value; return this; }
    }

    public static class OpeningHour
    {
        public Integer openAtHour = null;
        public Integer openAtMinute = null;
        public Integer closeAtHour = null;
        public Integer closeAtMinute = null;
        
        public Integer getOpenAtHour() { return openAtHour; }
        public OpeningHour setOpenAtHour(Integer value) { this.openAtHour = value; return this; }
        public Integer getOpenAtMinute() { return openAtMinute; }
        public OpeningHour setOpenAtMinute(Integer value) { this.openAtMinute = value; return this; }
        public Integer getCloseAtHour() { return closeAtHour; }
        public OpeningHour setCloseAtHour(Integer value) { this.closeAtHour = value; return this; }
        public Integer getCloseAtMinute() { return closeAtMinute; }
        public OpeningHour setCloseAtMinute(Integer value) { this.closeAtMinute = value; return this; }
    }

    public static enum FeatureType
    {
        BarSpeciality,
        BarType,
        Cuisine,
        SaveFoodAndMoney,
        MealType,
        Menu,
        OutdoorSeating,
        Parking,
        PaymentOptions,
        PriceMainDish,
        SubCategories,
        SubCategoriesAndBrands,
        EatingSuitabilities,
        TakeAway,
        WearPriceProfile,
        WheelChairAccessible,
        Wifi,
        WebShop,
        Filtering;
    }

    public static class BarSpecialityDto
    {
        public Long id = null;
        public String slug = null;
        public String title = null;
        
        public Long getId() { return id; }
        public BarSpecialityDto setId(Long value) { this.id = value; return this; }
        public String getSlug() { return slug; }
        public BarSpecialityDto setSlug(String value) { this.slug = value; return this; }
        public String getTitle() { return title; }
        public BarSpecialityDto setTitle(String value) { this.title = value; return this; }
    }

    public static class BarTypeDto
    {
        public Long id = null;
        public String slug = null;
        public String title = null;
        
        public Long getId() { return id; }
        public BarTypeDto setId(Long value) { this.id = value; return this; }
        public String getSlug() { return slug; }
        public BarTypeDto setSlug(String value) { this.slug = value; return this; }
        public String getTitle() { return title; }
        public BarTypeDto setTitle(String value) { this.title = value; return this; }
    }

    public static class CuisineDto
    {
        public Long id = null;
        public String label = null;
        public String slug = null;
        
        public Long getId() { return id; }
        public CuisineDto setId(Long value) { this.id = value; return this; }
        public String getLabel() { return label; }
        public CuisineDto setLabel(String value) { this.label = value; return this; }
        public String getSlug() { return slug; }
        public CuisineDto setSlug(String value) { this.slug = value; return this; }
    }

    public static enum Parking
    {
        StreetParking,
        ParkingGarageNearby;
    }

    public static enum PaymentOption
    {
        Visa,
        MasterCard,
        AmericanExpress,
        Diners,
        Vipps;
    }

    public static class EatingSuitability implements IAudit
    {
        public Long id = null;
        public String label = null;
        public String slug = null;
        public Integer position = null;
        public Date createdAt = null;
        public Date updatedAt = null;
        
        public Long getId() { return id; }
        public EatingSuitability setId(Long value) { this.id = value; return this; }
        public String getLabel() { return label; }
        public EatingSuitability setLabel(String value) { this.label = value; return this; }
        public String getSlug() { return slug; }
        public EatingSuitability setSlug(String value) { this.slug = value; return this; }
        public Integer getPosition() { return position; }
        public EatingSuitability setPosition(Integer value) { this.position = value; return this; }
        public Date getCreatedAt() { return createdAt; }
        public EatingSuitability setCreatedAt(Date value) { this.createdAt = value; return this; }
        public Date getUpdatedAt() { return updatedAt; }
        public EatingSuitability setUpdatedAt(Date value) { this.updatedAt = value; return this; }
    }

    public static enum PlaceType
    {
        Mall,
        Regular;
    }

    public static class PlaceContact
    {
        public String phone = null;
        public String email = null;
        public String website = null;
        public String webShop = null;
        
        public String getPhone() { return phone; }
        public PlaceContact setPhone(String value) { this.phone = value; return this; }
        public String getEmail() { return email; }
        public PlaceContact setEmail(String value) { this.email = value; return this; }
        public String getWebsite() { return website; }
        public PlaceContact setWebsite(String value) { this.website = value; return this; }
        public String getWebShop() { return webShop; }
        public PlaceContact setWebShop(String value) { this.webShop = value; return this; }
    }

    public static class PlaceAddress
    {
        public String street = null;
        public String postalCode = null;
        public String region = null;
        public String countryCode = null;
        
        public String getStreet() { return street; }
        public PlaceAddress setStreet(String value) { this.street = value; return this; }
        public String getPostalCode() { return postalCode; }
        public PlaceAddress setPostalCode(String value) { this.postalCode = value; return this; }
        public String getRegion() { return region; }
        public PlaceAddress setRegion(String value) { this.region = value; return this; }
        public String getCountryCode() { return countryCode; }
        public PlaceAddress setCountryCode(String value) { this.countryCode = value; return this; }
    }

    public static class TimeZoneDto
    {
        public TimeSpan baseUtcOffset = null;
        public String daylightName = null;
        public String displayName = null;
        public String id = null;
        public String standardName = null;
        public Boolean supportsDaylightSavingTime = null;
        
        public TimeSpan getBaseUtcOffset() { return baseUtcOffset; }
        public TimeZoneDto setBaseUtcOffset(TimeSpan value) { this.baseUtcOffset = value; return this; }
        public String getDaylightName() { return daylightName; }
        public TimeZoneDto setDaylightName(String value) { this.daylightName = value; return this; }
        public String getDisplayName() { return displayName; }
        public TimeZoneDto setDisplayName(String value) { this.displayName = value; return this; }
        public String getId() { return id; }
        public TimeZoneDto setId(String value) { this.id = value; return this; }
        public String getStandardName() { return standardName; }
        public TimeZoneDto setStandardName(String value) { this.standardName = value; return this; }
        public Boolean isSupportsDaylightSavingTime() { return supportsDaylightSavingTime; }
        public TimeZoneDto setSupportsDaylightSavingTime(Boolean value) { this.supportsDaylightSavingTime = value; return this; }
    }

    public static class PriceMainDishDto
    {
        public String title = null;
        public PriceMainDish slug = null;
        
        public String getTitle() { return title; }
        public PriceMainDishDto setTitle(String value) { this.title = value; return this; }
        public PriceMainDish getSlug() { return slug; }
        public PriceMainDishDto setSlug(PriceMainDish value) { this.slug = value; return this; }
    }

    public static enum PriceMainDish
    {
        Value,
        Medium,
        High,
        FineDining;
    }

}

Java GetPlaceRequest 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/get HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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