EP. Get List of Venue Sectors

Fetch hierarchy of sectors configured for company location (venue).

info

Company may contain a number of venues identified as locations, each venue can be formally represented as a hierarchy of sectors, e.g.:

- Lobby
- Retail
    - Ice Creamery
    - Drinks Fountain
    - Checkout Queue
- Cinema
- Arcade Games
    - Claw
    - Maze

URI

/api/v1/locations/{LOCATION_ID}/folders

Request Query Parameters

Request Parameter	Description
LOCATION_ID	UUID assigned to a specific location

Response

The schema of the `data` section of JSON response

{
  "type": "array",
  "items": {
  "type": "object",
    "properties": {
      "folder_id": {
        "type": "number"
      },
      "name": {
        "type": "string"
      },
      "parent_folder_id": {
        "type": "number"
      },    
      "children": {
        "type": "array",
        "items": { "$ref": "#" }
      }
    }
  }
}

Response Parameter	Description
folder_id	A unique identifier of a venue sector.
name	Sector name.
parent_folder_id	Identifier of a parent venue sector. 0, if this folder is at the top of a hierarchy.
children	List of other sectors formally grouped by this sector. 'Null', if the sector does not have any children.

Sample Response

{
 "data": [
  {
   "folder_id": 111,
   "parent_folder_id": 0,
   "name": "Arcade Games",
   "children": [
    {
     "folder_id": 112,
     "parent_folder_id": 111,
     "name": "Claw",
     "children": null
    },
    {
     "folder_id": 113,
     "parent_folder_id": 111,
     "name": "Maze",
     "children": null
    }
   ]
  },
  {
   "folder_id": 110,
   "parent_folder_id": 0,
   "name": "Cinema",
   "children": null
  },
  {
   "folder_id": 105,
   "parent_folder_id": 0,
   "name": "Lobby",
   "children": null
  },
  {
   "folder_id": 106,
   "parent_folder_id": 0,
   "name": "Retail",
   "children": [
    {
     "folder_id": 109,
     "parent_folder_id": 106,
     "name": "Checkout Queue",
     "path": "",
     "children": null
    },
    {
     "folder_id": 108,
     "parent_folder_id": 106,
     "name": "Drinks Fountain",
     "children": null
    },
    {
     "folder_id": 107,
     "parent_folder_id": 106,
     "name": "Ice Creamery",
     "children": null
    }
   ]
  }
 ],
 "success": true
}