Get a list of existing categories.
Get a list of categories
This endpoint retrieves the list of categories available for buildings.
A category describes the type of a building and indicates its purpose, for example house, office, or shop, and determines the building's divisibility rules.
Integrators call this endpoint before inserting or updating a building, to know which category values are currently configured, since the list is managed in the Bloxs application and can change over time.
Request Fields
This endpoint takes no request parameters.
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
category | string | No | Name of the category, for example house, office, or shop. Category values are configurable in the Bloxs application and cannot be managed through the API. |
divisibleType | integer | No | Divisibility rule tied to this category. Valid values are 1 (SingleUnit), 2 (DivisibleByUnits), or 3 (DivisibleByFloorArea). |
OK
SingleUnit = 1 DivisibleByUnits = 2 DivisibleByFloorArea = 3