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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCategoryTreeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Tree>
    <CategoryTreeWithFeaturesDto>
      <AbsoluteSlug>String</AbsoluteSlug>
      <Children>
        <CategoryTreeWithFeaturesDto>
          <AbsoluteSlug>String</AbsoluteSlug>
          <Children>
            <CategoryTreeWithFeaturesDto>
              <AbsoluteSlug>String</AbsoluteSlug>
              <Children i:nil="true" />
              <FeatureTypes>
                <FeatureDto>
                  <Label>String</Label>
                  <Slug>BarSpeciality</Slug>
                </FeatureDto>
              </FeatureTypes>
              <Id>0</Id>
              <Name>String</Name>
              <Slug>String</Slug>
            </CategoryTreeWithFeaturesDto>
          </Children>
          <FeatureTypes>
            <FeatureDto>
              <Label>String</Label>
              <Slug>BarSpeciality</Slug>
            </FeatureDto>
          </FeatureTypes>
          <Id>0</Id>
          <Name>String</Name>
          <Slug>String</Slug>
        </CategoryTreeWithFeaturesDto>
      </Children>
      <FeatureTypes>
        <FeatureDto>
          <Label>String</Label>
          <Slug>BarSpeciality</Slug>
        </FeatureDto>
      </FeatureTypes>
      <Id>0</Id>
      <Name>String</Name>
      <Slug>String</Slug>
    </CategoryTreeWithFeaturesDto>
  </Tree>
</GetCategoryTreeResponse>