• Document Up to Date

Tree

Returns the navigation tree with the specified depth for the specified store URL.

Resource Information

This service uses the tomcat application on port 8080 by default. To see a list of default ports click here

The context for this API is /.

HTTP Verb
GET
URL
/api/1/site/navigation/tree
Response Formats
JSON, XML

Parameters

Name
Type
Required
Description
url
String
The root folder of the tree
depth
Integer

The depth of the tree (defaults to 1)
currentPageUrl
String

The URL of the current page

Example

Request

GET .../api/1/site/navigation/tree.json?url=/site/website&depth=2

Response

Status 200 OK

 1{
 2  "label":"Home",
 3  "url":"/",
 4  "active":false,
 5  "subItems":[
 6    {
 7      "label":"Style",
 8      "url":"/style",
 9      "active":false,
10      "subItems":[]
11    },
12    {
13      "label":"Health",
14      "url":"/health",
15      "active":false,
16      "subItems":[]
17    },
18    {
19      "label":"Entertainment",
20      "url":"/entertainment",
21      "active":false,
22      "subItems":[]
23    },
24    {
25      "label":"Technology",
26      "url":"/technology",
27      "active":false,
28      "subItems":[]
29    }
30  ]
31}

Responses

Status
Location
Response Body
200

See example above.
500

"Internal server error"