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

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

Returns a collection of properties for a document versioning. No data fields such as ContentBinary or Keywords are returned with this call.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public string RevisionProperties(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	int versionNumber
)

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
An identifier of the document whose properties should be read
versionNumber
Type: SystemInt32
Indicate what version of the content to return.
The versionValues
-2Returns the draft properties. If no draft exists the currently approved content is returned.
-1Returns the draft properties. If no draft exists a ContentStudio.CSException is thrown.
0Returns the currently approved version properties. If no approved content exists a ContentStudio.CSException is thrown
Any existing version number:Returns the properties of the specified version.

Return Value

Type: String
Xml. The xml returned has the following syntax:
Xml
Copy
<root>
  <status>0</status>
  <statustext>Success</statustext>
  <properties 
      contentsize="Int32 value" 
      binarysize="Int32 value" 
      introductionsize="Int32 value" 
      headerpropertiessize="Int32 value" 
      revision="Int32 value" 
      revisiondate="DateTime string e.g. 1900-01-01T00:00:00" 
      modifiedbyid="Int32 value" 
      modifieddate="DateTime string e.g. 1900-01-01T00:00:00" 
      checkedoutbyid="Int32 value" 
      checkedoutdate="DateTime string e.g. 1900-01-01T00:00:00" 
      lastcheckout="DateTime string e.g. 1900-01-01T00:00:00" 
      approvedbyid="Int32 value" 
      createddate="DateTime string e.g. 1900-01-01T00:00:00" 
      statusint="Int32 value" />
</root>
Exceptions
ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions
READ permission on the document is required to read a draft and BROWSE for any approved version. This method supports anonymous users.
See Also

Reference

DocumentReader Class
ContentStudio.Document Namespace