infoRouter Document Management System - Web Services API Documentation
SetDocumentRetention
Sets the Retension Period of the specified document.
Syntax 
[Visual Basic]
Public Function SetDocumentRetention(ByVal AuthenticationTicket As String, _
                                     ByVal Path As String, _
                                     ByVal RetentionStatus As Short, _
                                     ByVal RetainUntil As Date) As System.Xml.XmlDocument
Parameters

AuthenticationTicket

infoRouter Authentication Ticket

Path

an infoRouter document path

RetensionStatus

Specifies the type of retension (0=No Retension;1=Forever;2=Until Specied Date)

RetainUntil

Specifies the retention period of the document if RetensionStatus=2
Return Value
returns xml fragment.
<response success="true" error="">
if success attribute is "true", the retention status has been updated successfully.
if success attribute is "false", the error attribute indicates the encountered
error.
Remarks
The caller must have at least "Change" right on the document.
Example 

							
				

				

					See Also
				

				

					
						Set Document Importance | Update Document Properties

								
				

				

					Syntax based on infoRouter Document Management System Web Services API Version 7.0
				

				

					Copyright() 1998-2003 Active Innovations, Inc.
				

				

					infoRouter Document Management System