BusinessApi

<back to all web services

GetCategoryTreeRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/category/get_tree
GetCategoryTreeRequest Parameters:
NameParameterData TypeRequiredDescription
AbsoluteSlugquerystringNo
GetCategoryTreeResponse Parameters:
NameParameterData TypeRequiredDescription
TreeformList<CategoryTreeWithFeaturesDto>Yes
CategoryTreeWithFeaturesDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SlugformstringYes
AbsoluteSlugformstringYes
NameformstringYes
ChildrenformList<CategoryTreeWithFeaturesDto>No
FeatureTypesformList<FeatureDto>No
FeatureDto 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 .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: business-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,
			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
				}
			]
		}
	]
}