VersionHistoryGetVersionHistory 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.]

Retrieves a list of the version history of an element.

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

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

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).
xmlParameterData
Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema
status
Type: SystemInt32
An integer indicating result of the call. Zero is success.
statusText
Type: SystemString
The textual representation of the call result.

Return Value

Type: String
Xml with the following sample syntax:
<root>
  <status>0</status>
  <statustext>Success</statustext>
  <revisions>
     <revision>
        <ishistory>Value</ishistory>
        <revision>Value</revision>
        <createdby>Value</createdby>
        <createddate>Value</createddate>
        <revisedby>Value</revisedby>
        <revisiondate>Value</revisiondate>
        <modifiedby>Value</modifiedby>
        <modifieddate>Value</modifieddate>
     </revision>
     <!--more revision element can follow-->
  </revisions>
</root>

The returned document has a collection of revision elements that has the following child elements that contains the actual data. Note that in some cases some of the data elements can be omitted in the result.

ElementData typeDescription
root/revisions/revision/ishistoryBoolean (0 or 1)Indicates whether the version is in the version history. Only the version published be false.
root/revisions/revision/revisionIntegerThe version number.
root/revisions/revision/createdbyStringThe name of the person that created the version. This field is omitted if the user account has been deleted in Content Studio.
root/revisions/revision/createddateDateTime The date and time when the version was created. This is in the standard SortableDateTime pattern (based on ISO 8601 [yyyy-MM-ddTHH:mm:ss]) using the local time of the server when the version was created.
root/revisions/revision/revisedbyStringThe name of the person that approved the version for publishing. This field is omitted if the user account has been deleted in Content Studio.
root/revisions/revision/revisiondateDateTimeThe date and time when the version was approved for publishing. This is in the standard SortableDateTime pattern (based on ISO 8601 [yyyy-MM-ddTHH:mm:ss]) using the local time of the server when the version was approved.
root/revisions/revision/modifiedbyStringThe name of the last person that modified the version. This field is omitted if the user account has been deleted in Content Studio.
root/revisions/revision/modifieddateDateTimeThe date and time when the version was modified. This is in the standard SortableDateTime pattern (based on ISO 8601 [yyyy-MM-ddTHH:mm:ss]) using the local time of the server when the version was modified.
Content Studio permissions

READ permission on the document is required.
Remarks

This is the backwards compatible implementation of this method. This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the status and statusText output parameters.
See Also

Reference