DocumentReaderGetChildDocuments Method (ConnectionId, SessionId, String, Int32, String) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Gets all child documents for a certain document.

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

public string GetChildDocuments(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	out int status,
	out string statusText


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema
Type: SystemInt32
An integer indicating result of the call. Zero is success.
Type: SystemString
The textual representation of the call result.

Return Value

Type: String

   <status>integer value</status>
   <statustext>string value</statustext>
       <document id="integer value" 
                    name="string value" 
                    child="bit value" 
                    parentid="integer value" 
                    cid="integer value" 
                    type="string value" 
                    deleted="bit value">
         <category module="string value" />
       <!-- more document can follow -->
/root/statusintegerIndicates the outcome of the call; always 0 (success)
/root/statustextstringThe textual outcome of the call; always Success
/root/documents/document---An element representing one single child document
/root/documents/document@idintegerThe document's identifier
/root/documents/document@namestringThe name of the document
/root/documents/document@childbit (0 | 1)1 if the document has child documents; otherwise, 0
/root/documents/document@parentidintegerThe identifier of the parent document.
/root/documents/document@cidintegerThe category id of the document
/root/documents/document@typestringThe content type (mime type) of the document
/root/documents/document@deletedbit (0 | 1)1 if the document is deleted; otherwise, 0
/root/documents/document/category@modulestringThe name of the document module. See ModuleName for information about the meaning of this value.
Content Studio permissions

READ permission on the parent document is required.
See Also