3.1.5.3.15 get web struct
This method is used to get the internal web structure and ELEMENT-IDs (section 2.2.2.2.28) for the documents that make up that web structure. The web structure is conceptually a tree of nodes for each linked document, with links from each node to its parent and child nodes. The top-level or global pages displayed by the client in a navigation view are considered the child nodes of a virtual root node.<33>
Parameters
service_name: This parameter is deprecated. See service_name in section 3.1.5.3.1.
eidHead: The ELEMENT-ID of the root node that the server is required to use when retrieving the web structure. The STRUCTURE-ELEMENTS (section 2.2.2.2.32) are retrieved starting with this node and descending through the hierarchy.
This parameter MAY have a special value of 0 or 1, for sending the following predefined settings.
|
Value |
Meaning |
|---|---|
|
0 |
Start at the virtual root. If the levels parameter is set to get all levels, this retrieves the entire web structure. |
|
1 |
Start with the first temporary element I. |
includeHead: A BOOLEAN (section 2.2.2.1.3) value that indicates whether to include the node identified by the eidHead parameter in the results.
|
Value |
Meaning |
|---|---|
|
TRUE |
The server MUST return the node specified by the eidHead parameter, along with the nodes specified by the levels parameter. |
|
FALSE |
The server MUST return only the nodes specified by the levels parameter. |
levels: An INT (section 2.2.2.1.2) that identifies the number of levels to retrieve from the navigation structure store for the site. A value of -1 means that the server MUST retrieve all levels below the specified starting node. For a positive integer n, levels specifies that the server MUST retrieve n levels of child nodes. If the includeHead parameter is set to TRUE, 0 is legal and means that the server MUST retrieve just the specified node.
Entry Point
FPAuthorScriptUrl
Return Values
elements: A VECTOR-STRUCTURE-ELEMENT that contains a list of the STRUCTURE-ELEMENT data for each returned node in the web structure requested.