MLCDocumentsGetSiblingCollection Method (ConnectionId, SessionId, String, String, MLCDocumentsSiblingCollectionSortOrder, Boolean, DateTime) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Returns data of a list of sibling documents that are part of an MLC.

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

public string GetSiblingCollection(
	ConnectionId connectionId,
	SessionId sessionId,
	string documentList,
	string languageShortName,
	MLCDocumentsSiblingCollectionSortOrder sortOrder,
	bool returnMasterIfMissing,
	DateTime previewDate
)

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).
documentList
Type: SystemString
A comma separated list of MLC documents.
languageShortName
Type: SystemString
The short name of the desired language.
sortOrder
Type: ContentStudio.Document.MLCMLCDocumentsSiblingCollectionSortOrder
Indicates the sort order of the list
returnMasterIfMissing
Type: SystemBoolean
Set this parameter to true to force the method to return the master document if the sibling cannot be found.
previewDate
Type: SystemDateTime
A preview date. To use the current date you can pass MaxValue

Return Value

Type: String
XML, one row for each document in the list
<root>
  <status>0</status>
  <statustext>Success</statustext>
  <documents>
     <document documentid="integer value" siblingid="integer value" siblingtype="integer value"/>
  </documents>
  <ptid>Integer value</ptid>
  <returnedptidlevel>Integer value</returnedptidlevel>
</root>
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
  • 1001 - The SessionID is invalid.
  • 1002 - Permission denied.
  • 1100 - The document does not exist.
  • 1551 - The language is not valid.
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

Any caller that has a valid session in Content Studio can successfully execute this procedure. This call supports anonymous calls.
See Also

Reference