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

export module BackofficeApi
{
    // @ts-nocheck

    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',
    }

}

TypeScript GetCategoryTreeRequest 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 /category/get_tree HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
				}
			]
		}
	]
}