DocumentReader.GetLevelInfo Method

DocumentReaderGetLevelInfo Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Gets information about the level and ordinal position for a document that is part of a document hierarchy.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

public string GetLevelInfo(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	bool includeRoot
)

Public Function GetLevelInfo ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId,
	includeRoot As Boolean
) As String

Parameters

connectionId: Type: ContentStudioConnectionId
A value that identifies the web site
sessionId: Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
documentId: Type: ContentStudio.DocumentDocumentId
A value that identifies the document whose level info should be displayed.
includeRoot: Type: SystemBoolean
Determines whether the root level should be included in the output or not.

Return Value

Type: String
Xml with the following syntax

Copy

<root>
  <status>0</status>
  <statustext>Success</statustext>
  <documentname>My document</documentname>
  <leveltext>The text</leveltext>
  <level no="0" value="0" />
  <level no="1" value="4" />
  <level no="2" value="1" />
  <level no="3" value="1" />
  <level no="4" value="1" />
  <level no="5" value="2" />
  <!-- more level elements can follow -->
</root>

Returned elementsIndicates the outcome of the call, value is always 0

Path	Value	Description
root/status	Integer
root/statustext	String	Indicates the outcome of the call, value is always "Success"
root/documentname	String	The document name
root/leveltext	String	contains the textual version of the individual level data members. See remarks below.
root/level		Defines a single level information node
root/level@no	Integer	The level of the document where 0 is the root level. The highest level will represent the position and level of the document itself. Level 0 will only be returned if includeRoot is true.
root/level@value	Integer	The ordinal position within the level. In the example above the document will have position 2 on level 5 with a parent document on level 4 with position 1. 1 represents the first position.

The leveltext value contains the textual version of the individual level data members. The document sample return value above will have the level info 0.4.1.1.1.2

The graphical representation of the sample return value above might look like this.

             -RootDocument0
                | +Document1:1
                | +Document1:2
                | +Document1:3
                | -Document1:4
                   | -Document2:1
                       | -Document3:1
                           | -Document4:1
                               | +Document5:1
                               | -My document
                | +Document1:5

Exceptions

Exception	Condition
CSInvalidSessionException	The session is invalid
CSPermissionDeniedException	Permission denied
CSDocumentNotFoundException	The document does not exist
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

BROWSE permission is required on the document. This call supports anonymous logins.

Reference

DocumentReader Class

ContentStudio.Document Namespace