Name
Last updated on
May 15, 2021
Availability
Breeze 4
Description
Describes the folder hierarchy that contains a SCO.
The sco-nav call is useful for creating a navigation tree, breadcrumb trail, or any other type of user interface hierarchy. The response contains a list of sco elements, one for the SCO you are querying and one for each of its enclosing folders up to the top-level folder. The top-level folder is one of the list of folders returned by sco-shortcuts.
In each sco element, the depth attribute indicates how many hierarchical levels the SCO is from the SCO you specify in the request. A depth of 0 indicates the SCO you are querying, a depth of 1 indicates the folder that contains the SCO, and so on.
Request URL
http://server_name/api/xml ?action=sco-nav &sco-id=integer &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
sco-id |
BIGINT |
Y |
The unique ID of a SCO for which you want a folder hierarchy up to the root level. |
|
session |
String |
N |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Filters
Results cannot be filtered or sorted.
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=allowedValue /> <sco-nav> <sco sco-id=integer type=allowedValue icon=allowedValue depth=integer> <name>string</name> </sco> ... </sco-nav> </results>
Response values
Element |
Attribute |
Type |
Description |
|---|---|---|---|
| results | Container |
All results the action returns. |
|
| status | Empty, with attributes |
The status of the response. |
|
| code | Allowed value |
A code indicating the response status (see status). |
|
| sco-nav | Container |
The entire navigation tree from the top-level folder to the SCO. |
|
| sco | Container |
Information about one SCO in the hierarchy. |
|
| sco-id | BIGINT |
The unique ID of the SCO. |
|
| type | Allowed value |
The type of SCO (see type for values). |
|
| icon | Allowed value |
The icon that visually represents the SCO (see icon for values). |
|
| depth | Integer |
A number representing the level of a SCO in the folder hierarchy relative to the SCO passed in the request (0 for the passed SCO, 1 for one level above, and so on). Values increase as you move up the hierarchy toward the top-level folder. |
|
| name | String |
The name of the SCO. |
Sample request
https://example.com/api/xml?action=sco-nav&sco-id=2006334909
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <sco-nav> <sco sco-id="624522" type="folder" icon="folder" depth="2"> <name>User Content</name> </sco> <sco sco-id="2006258747" type="folder" icon="folder" depth="1"> <name>joy@acme.com</name> </sco> <sco sco-id="2006334909" type="content" icon="producer" depth="0"> <name>Test Quiz</name> </sco> </sco-nav> </results>
See also
