IndexedTreeReaderGetSiblings Method (ConnectionId, SessionId, DocumentId) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Returns tree index data for all siblings documents

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

public string GetSiblings(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId
)

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
ID of document to get data from, this can be any document in the tree

Return Value

Type: String
XML
<root><status>success></status><statustext>Success</statustext>
<documents iseof="0" treeid="1110" count="1" treemembers="200">
<document documentid="1111" parent="1110" level="1" position="3" index="3" children="6" siblings="3" documentname="MyDocument" label="" norootlabel="" />
<!--more document can follow -->
</documents>
</root>
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSInvalidParameterExceptionA parameter has an invalid value
CSDocumentNotFoundExceptionThe document could not be found
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

All users can successfully execute this method.
See Also

Reference