CreateRandDSchedule

Visual Basic (declaration)
Public Function CreateRandDSchedule( _ ByVal AuthenticationTicket as String, _ ByVal RDDefXML as String) as XmlNode

C# (declaration)
public XmlNode CreateRandDSchedule( string AuthenticationTicket, string RDDefXML)

AuthenticationTicket
    string infoRouter ticket
RDDefXML
    string Retention and Disposition definition xml string.

returns xml fragment.
<response success="true" error="">
if success = "true", the function returns if the retention and disposition period has been added successfully.
if success = "false", the error attribute returns the error description.

The RDDefXML format must be in the following format.


<RetentionDispositionSchedule
Name="new Retention and Disposition"
Description="new Retention and Disposition 1 description"
URL="http://www.acme.com/rddefs/rdsample-1234.htm"
ReferenceNumber="12334"
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"/>


</xml>

RetentionType:
0 None
1 Temporary
2 Permanent

if the Retention Type is 1 (Temporary), the retention trigger can not be 0 (none) and a valid retention period must be specified as in years, month(s) or day(s)
if the Retention Type is 2 (Permanent), Dispostion type must be 0 (None)

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

if Disposition Type is 1 (Final Disposition) or 2 (Transfer to External Agency), the Disposition Trigger cannot be 0 (none)


DispositionTrigger

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

if Dispostion Trigger is 1 (On Create) or 2 (On Cutoff) a valid dispostion period must be specified.
if Dispostion Trigger is 3 The retention must be exists. In this case the Disposition is period is optional. (The diposition action will be executed right after on retention end)

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

GetRandDScheduleInfo | GetRandDSchedules