| Required role: | Business |
| GET | /place/getbootstrap |
|---|
<?php namespace BusinessApi;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class OpeningHour implements JsonSerializable
{
public function __construct(
/** @var int */
public int $openAtHour=0,
/** @var int */
public int $openAtMinute=0,
/** @var int */
public int $closeAtHour=0,
/** @var int */
public int $closeAtMinute=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['openAtHour'])) $this->openAtHour = $o['openAtHour'];
if (isset($o['openAtMinute'])) $this->openAtMinute = $o['openAtMinute'];
if (isset($o['closeAtHour'])) $this->closeAtHour = $o['closeAtHour'];
if (isset($o['closeAtMinute'])) $this->closeAtMinute = $o['closeAtMinute'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->openAtHour)) $o['openAtHour'] = $this->openAtHour;
if (isset($this->openAtMinute)) $o['openAtMinute'] = $this->openAtMinute;
if (isset($this->closeAtHour)) $o['closeAtHour'] = $this->closeAtHour;
if (isset($this->closeAtMinute)) $o['closeAtMinute'] = $this->closeAtMinute;
return empty($o) ? new class(){} : $o;
}
}
class WeeklyOpeningHours implements JsonSerializable
{
public function __construct(
/** @var OpeningHour|null */
public ?OpeningHour $monday=null,
/** @var OpeningHour|null */
public ?OpeningHour $tuesday=null,
/** @var OpeningHour|null */
public ?OpeningHour $wednesday=null,
/** @var OpeningHour|null */
public ?OpeningHour $thursday=null,
/** @var OpeningHour|null */
public ?OpeningHour $friday=null,
/** @var OpeningHour|null */
public ?OpeningHour $saturday=null,
/** @var OpeningHour|null */
public ?OpeningHour $sunday=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['monday'])) $this->monday = JsonConverters::from('OpeningHour', $o['monday']);
if (isset($o['tuesday'])) $this->tuesday = JsonConverters::from('OpeningHour', $o['tuesday']);
if (isset($o['wednesday'])) $this->wednesday = JsonConverters::from('OpeningHour', $o['wednesday']);
if (isset($o['thursday'])) $this->thursday = JsonConverters::from('OpeningHour', $o['thursday']);
if (isset($o['friday'])) $this->friday = JsonConverters::from('OpeningHour', $o['friday']);
if (isset($o['saturday'])) $this->saturday = JsonConverters::from('OpeningHour', $o['saturday']);
if (isset($o['sunday'])) $this->sunday = JsonConverters::from('OpeningHour', $o['sunday']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->monday)) $o['monday'] = JsonConverters::to('OpeningHour', $this->monday);
if (isset($this->tuesday)) $o['tuesday'] = JsonConverters::to('OpeningHour', $this->tuesday);
if (isset($this->wednesday)) $o['wednesday'] = JsonConverters::to('OpeningHour', $this->wednesday);
if (isset($this->thursday)) $o['thursday'] = JsonConverters::to('OpeningHour', $this->thursday);
if (isset($this->friday)) $o['friday'] = JsonConverters::to('OpeningHour', $this->friday);
if (isset($this->saturday)) $o['saturday'] = JsonConverters::to('OpeningHour', $this->saturday);
if (isset($this->sunday)) $o['sunday'] = JsonConverters::to('OpeningHour', $this->sunday);
return empty($o) ? new class(){} : $o;
}
}
class OpeningHours implements JsonSerializable
{
public function __construct(
/** @var WeeklyOpeningHours|null */
public ?WeeklyOpeningHours $weekly=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['weekly'])) $this->weekly = JsonConverters::from('WeeklyOpeningHours', $o['weekly']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->weekly)) $o['weekly'] = JsonConverters::to('WeeklyOpeningHours', $this->weekly);
return empty($o) ? new class(){} : $o;
}
}
enum FeatureType : string
{
case BarSpeciality = 'BarSpeciality';
case BarType = 'BarType';
case Cuisine = 'Cuisine';
case SaveFoodAndMoney = 'SaveFoodAndMoney';
case MealType = 'MealType';
case Menu = 'Menu';
case OutdoorSeating = 'OutdoorSeating';
case Parking = 'Parking';
case PaymentOptions = 'PaymentOptions';
case PriceMainDish = 'PriceMainDish';
case SubCategories = 'SubCategories';
case SubCategoriesAndBrands = 'SubCategoriesAndBrands';
case EatingSuitabilities = 'EatingSuitabilities';
case TakeAway = 'TakeAway';
case WearPriceProfile = 'WearPriceProfile';
case WheelChairAccessible = 'WheelChairAccessible';
case Wifi = 'Wifi';
case WebShop = 'WebShop';
case Filtering = 'Filtering';
}
class BarSpecialityDto implements JsonSerializable
{
public function __construct(
/** @var int */
public int $id=0,
/** @var string */
public string $slug='',
/** @var string */
public string $title=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['slug'])) $this->slug = $o['slug'];
if (isset($o['title'])) $this->title = $o['title'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->slug)) $o['slug'] = $this->slug;
if (isset($this->title)) $o['title'] = $this->title;
return empty($o) ? new class(){} : $o;
}
}
class BarTypeDto implements JsonSerializable
{
public function __construct(
/** @var int */
public int $id=0,
/** @var string */
public string $slug='',
/** @var string */
public string $title=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['slug'])) $this->slug = $o['slug'];
if (isset($o['title'])) $this->title = $o['title'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->slug)) $o['slug'] = $this->slug;
if (isset($this->title)) $o['title'] = $this->title;
return empty($o) ? new class(){} : $o;
}
}
class CuisineDto implements JsonSerializable
{
public function __construct(
/** @var int */
public int $id=0,
/** @var string */
public string $label='',
/** @var string */
public string $slug=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['label'])) $this->label = $o['label'];
if (isset($o['slug'])) $this->slug = $o['slug'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->label)) $o['label'] = $this->label;
if (isset($this->slug)) $o['slug'] = $this->slug;
return empty($o) ? new class(){} : $o;
}
}
enum Parking : string
{
case StreetParking = 'StreetParking';
case ParkingGarageNearby = 'ParkingGarageNearby';
}
enum PaymentOption : string
{
case Visa = 'Visa';
case MasterCard = 'MasterCard';
case AmericanExpress = 'AmericanExpress';
case Diners = 'Diners';
case Vipps = 'Vipps';
}
class EatingSuitability implements IAudit, JsonSerializable
{
public function __construct(
/** @var int */
public int $id=0,
/** @var string|null */
public ?string $label=null,
/** @var string|null */
public ?string $slug=null,
/** @var int */
public int $position=0,
/** @var DateTime */
public DateTime $createdAt=new DateTime(),
/** @var DateTime */
public DateTime $updatedAt=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['label'])) $this->label = $o['label'];
if (isset($o['slug'])) $this->slug = $o['slug'];
if (isset($o['position'])) $this->position = $o['position'];
if (isset($o['createdAt'])) $this->createdAt = JsonConverters::from('DateTime', $o['createdAt']);
if (isset($o['updatedAt'])) $this->updatedAt = JsonConverters::from('DateTime', $o['updatedAt']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->label)) $o['label'] = $this->label;
if (isset($this->slug)) $o['slug'] = $this->slug;
if (isset($this->position)) $o['position'] = $this->position;
if (isset($this->createdAt)) $o['createdAt'] = JsonConverters::to('DateTime', $this->createdAt);
if (isset($this->updatedAt)) $o['updatedAt'] = JsonConverters::to('DateTime', $this->updatedAt);
return empty($o) ? new class(){} : $o;
}
}
enum PlaceType : string
{
case Mall = 'Mall';
case Regular = 'Regular';
}
class PlaceContact implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $phone=null,
/** @var string|null */
public ?string $email=null,
/** @var string|null */
public ?string $website=null,
/** @var string|null */
public ?string $webShop=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['phone'])) $this->phone = $o['phone'];
if (isset($o['email'])) $this->email = $o['email'];
if (isset($o['website'])) $this->website = $o['website'];
if (isset($o['webShop'])) $this->webShop = $o['webShop'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->phone)) $o['phone'] = $this->phone;
if (isset($this->email)) $o['email'] = $this->email;
if (isset($this->website)) $o['website'] = $this->website;
if (isset($this->webShop)) $o['webShop'] = $this->webShop;
return empty($o) ? new class(){} : $o;
}
}
class PlaceAddress implements JsonSerializable
{
public function __construct(
/** @var string */
public string $street='',
/** @var string */
public string $postalCode='',
/** @var string */
public string $region='',
/** @var string */
public string $countryCode=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['street'])) $this->street = $o['street'];
if (isset($o['postalCode'])) $this->postalCode = $o['postalCode'];
if (isset($o['region'])) $this->region = $o['region'];
if (isset($o['countryCode'])) $this->countryCode = $o['countryCode'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->street)) $o['street'] = $this->street;
if (isset($this->postalCode)) $o['postalCode'] = $this->postalCode;
if (isset($this->region)) $o['region'] = $this->region;
if (isset($this->countryCode)) $o['countryCode'] = $this->countryCode;
return empty($o) ? new class(){} : $o;
}
}
class TimeZoneDto implements JsonSerializable
{
public function __construct(
/** @var DateInterval|null */
public ?DateInterval $baseUtcOffset=null,
/** @var string */
public string $daylightName='',
/** @var string */
public string $displayName='',
/** @var string */
public string $id='',
/** @var string */
public string $standardName='',
/** @var bool|null */
public ?bool $supportsDaylightSavingTime=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['baseUtcOffset'])) $this->baseUtcOffset = JsonConverters::from('DateInterval', $o['baseUtcOffset']);
if (isset($o['daylightName'])) $this->daylightName = $o['daylightName'];
if (isset($o['displayName'])) $this->displayName = $o['displayName'];
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['standardName'])) $this->standardName = $o['standardName'];
if (isset($o['supportsDaylightSavingTime'])) $this->supportsDaylightSavingTime = $o['supportsDaylightSavingTime'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->baseUtcOffset)) $o['baseUtcOffset'] = JsonConverters::to('DateInterval', $this->baseUtcOffset);
if (isset($this->daylightName)) $o['daylightName'] = $this->daylightName;
if (isset($this->displayName)) $o['displayName'] = $this->displayName;
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->standardName)) $o['standardName'] = $this->standardName;
if (isset($this->supportsDaylightSavingTime)) $o['supportsDaylightSavingTime'] = $this->supportsDaylightSavingTime;
return empty($o) ? new class(){} : $o;
}
}
enum PriceMainDish : string
{
case Value = 'Value';
case Medium = 'Medium';
case High = 'High';
case FineDining = 'FineDining';
}
class PriceMainDishDto implements JsonSerializable
{
public function __construct(
/** @var string */
public string $title='',
/** @var PriceMainDish|null */
public ?PriceMainDish $slug=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['title'])) $this->title = $o['title'];
if (isset($o['slug'])) $this->slug = JsonConverters::from('PriceMainDish', $o['slug']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->title)) $o['title'] = $this->title;
if (isset($this->slug)) $o['slug'] = JsonConverters::to('PriceMainDish', $this->slug);
return empty($o) ? new class(){} : $o;
}
}
enum BusinessRole : string
{
case Owner = 'Owner';
case Manager = 'Manager';
case Sales = 'Sales';
case Marketing = 'Marketing';
case Other = 'Other';
}
PHP GetPlaceBootstrapRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}