Returns specified Retention and Disposition schedule definition.

Syntax

Visual Basic (declaration)
Public Function GetRandDScheduleInfo( _ 
ByVal AuthenticationTicket as String, _ ByVal RDDefId as Integer) as XmlNode

C# (declaration)
public XmlNode GetRandDScheduleInfo( 
string AuthenticationTicket, integer RDDefId)

Parameters

AuthenticationTicket
    string infoRouter ticket
RDDefId
    integer Retention and Disposition definition Id.

Return Value

returns xml fragment.
<response success="true" error="">
if success = "true", the function returns the <RetentionDispositionSchedule> subnode.
if success = "false", the error attribute returns the error description.



<response success="true" error="">

<RetentionDispositionSchedule DefId="2215" 
Name="Sample Retention and Disposition 1" 
Description="Sample Retention and Disposition 1 description" 
URL="http://www.acme.com/rddefs/rdsample1.htm" 
ReferenceNumber="1234" 
SourceAuthority="Victoria authority" 
RecordsSeriesName="" 
RetentionType="1" 
RetentionTrigger="1" 
RetentionPeriodYears="3" 
RetentionPeriodMonths="0" 
RetentionPeriodDays="0" 
DispositionType="2" 
DispositionTrigger="2" 
DispositionPeriodYears="2" 
DispositionPeriodMonths="0" 
DispositionPeriodDays="0" 
TransferAgency="victoria control center" 
MoveFolderId="0"/>

</response>



RetentionType enumeration
0 None
1 Temporary
2 Permanent


RetentionTrigger
0 None
1 On Create
2 On CutOff


RetentionPeriodYears : Number of years
RetentionPeriodMonth : Number of months
RetentionPeriodDays : Number of days


DispositionType :

0 - None
1 - Final Disposition
2 - Transfer To External Agency


DispositionTrigger

0 - None
1 - On Create
2 - On CutOff
3 - On Retention End


DispositionPeriodYears : Number of years
DispositionPeriodMonths : Number of months
DispositionPeriodDays : Number of days






Remarks