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
<?php namespace BackofficeApi;

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


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

PHP 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
				}
			]
		}
	]
}