DocumentReaderGetApprovedDocumentInformation Method Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Returns information about a document that can be obtained by a caller that only has the BROWSE permission on the document.

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

public string GetApprovedDocumentInformation(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	bool loadContentData,
	out DocumentTypes documentType


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: ContentStudio.DocumentDocumentId
A value that identifies the document whose details should be displayed.
Type: SystemBoolean
Indicates whether the content related data should be returned or not. Set this parameter to false unless you really need the content data such as Introduction and MenuData
Type: ContentStudio.DocumentDocumentTypes
When this method returns documentType contains information about the type of document requested.

Return Value

Type: String
Xml with the following sample syntax.

    <introduction>Content Studio 5.0</introduction>
The eptdata fields will only be present when the document is an EPT document. The archivedate field will not be present unless an archive date has been specified for the document. The virtualpath field was added in Content Studio 5.4

CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSDocumentNotFoundExceptionThe document could not be found
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

BROWSE permission is required on the document.

There is an object oriented version of this call CSApprovedDocumentInformation that are much more simpler to use.
For a complete details of a document you can use the GetDetails(ConnectionId, SessionId, DocumentId, Int32) call or the the CSDocumentInformation object but in those cases the caller needs READ permission on the document in question.
See Also