Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
XML, one row for each document in the list
Any caller that has a valid session in Content Studio can successfully execute this procedure. This call supports anonymous calls.
[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, ref int pTId, out MLCDocumentsReturnedPTIDTypes returnedPTIDlevel )
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. - pTId
- Type: SystemInt32
The id of a PTI. After the call this parameter is filled with a presentation template according to the same rule as the sibling document. - returnedPTIDlevel
- Type: ContentStudio.Document.MLCMLCDocumentsReturnedPTIDTypes
Returns the type of returned PTID. Can be one of the MLCDocumentsReturnedPTIDTypes enumeration values
Return Value
Type: StringXML, 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
Exception | Condition |
---|---|
CSException | A business rule was violated in the underlying Content Studio database
|
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
See Also