Breadcrumb
Returns the navigation items that form the breadcrumb 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/breadcrumb |
Response Formats
|
JSON, XML |
Parameters
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
url
|
String
|
✓
|
The URL used to build the breadcrumb
|
root
|
String
|
The starting point of the breadcrumb
|
Example
Request
GET .../api/1/site/navigation/breadcrumb.json?url=/site/website/style&root=/site/website
Response
Status 200 OK
1[
2 {
3 "label": "Home",
4 "url": "/",
5 "active": false,
6 "subItems": null,
7 },
8 {
9 "label": "Style",
10 "url": "/style",
11 "active": false,
12 "subItems": null,
13 }
14]
Responses
Status
|
Location
|
Response Body
|
|---|---|---|
200
|
See example above.
|
|
500
|
"Internal server error" |