Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml with the following sample syntax.
Note
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
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.
[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)
Syntax
public string GetApprovedDocumentInformation( ConnectionId connectionId, SessionId sessionId, DocumentId documentId, bool loadContentData, out DocumentTypes documentType )
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
A value that identifies the document whose details should be displayed. - loadContentData
- 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 - documentType
- Type: ContentStudio.DocumentDocumentTypes
When this method returns documentType contains information about the type of document requested.
Return Value
Type: StringXml with the following sample syntax.
<document> <documentname>CS_Logo.gif</documentname> <filename>System/Files/15C7FE63-D64E-4CB9-945A-E4625CD43C62.GIF</filename> <publishstatus>2</publishstatus> <contenttype>image/GIF</contenttype> <publishdate>2002-06-11T14:15:00</publishdate> <archivedate>2003-08-28T09:56:46</archivedate> <modifieddate>2003-08-28T09:56:46</modifieddate> <createddate>2002-06-11T14:17:00</createddate> <imagesavailable>0</imagesavailable> <categoryid>8</categoryid> <parentdocumentid>1000</parentdocumentid> <virtualpath>myVirtualPath</virtualpath> <content> <introduction>Content Studio 5.0</introduction> <revision>1</revision> <revisiondate>2003-08-28T09:56:46</revisiondate> <menudata></menudata> <menutarget></menutarget> <menuurl></menuurl> <eptdata></eptdata> </content> </document>
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
Exceptions
Exception | Condition |
---|---|
CSPermissionDeniedException | The caller has no permission to perform the requested action |
CSInvalidSessionException | The session is invalid |
CSDocumentNotFoundException | The document could not be found |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
Remarks
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