BackofficeApi

<back to all web services

GetCategoryTreeRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/category/get_tree
GetCategoryTreeRequest Parameters:
NameParameterData TypeRequiredDescription
AbsoluteSlugquerystringNo
GetCategoryTreeResponse Parameters:
NameParameterData TypeRequiredDescription
TreeformList<BackofficeCategoryTreeDto>Yes
BackofficeCategoryTreeDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SlugformstringYes
AbsoluteSlugformstringYes
NameformstringYes
ImageUrlformstringNo
AllImageUrlformstringNo
DefaultPlaceImageUrlformstringNo
ChildrenformList<BackofficeCategoryTreeDto>No
FeatureTypesformList<FeatureTypeDto>No
FeatureTypeDto 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

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /category/get_tree HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"tree":[{"id":0,"slug":"String","absoluteSlug":"String","name":"String","imageUrl":"String","allImageUrl":"String","defaultPlaceImageUrl":"String","children":[{"id":0,"slug":"String","absoluteSlug":"String","name":"String","imageUrl":"String","allImageUrl":"String","defaultPlaceImageUrl":"String","children":[{"id":0,"slug":"String","absoluteSlug":"String","name":"String","imageUrl":"String","allImageUrl":"String","defaultPlaceImageUrl":"String","featureTypes":[{"slug":"BarSpeciality","label":"String"}]}],"featureTypes":[{"slug":"BarSpeciality","label":"String"}]}],"featureTypes":[{"slug":"BarSpeciality","label":"String"}]}]}