Skip to content

GetFolderRandDSchedule API

Returns the Retention and Disposition (R&D) schedule assigned to a folder identified by path. Returns the full schedule definition. If no schedule is assigned, returns a DefId of 0.

Endpoint

/srv.asmx/GetFolderRandDSchedule

Methods

  • GET /srv.asmx/GetFolderRandDSchedule?authenticationTicket=...&Path=...
  • POST /srv.asmx/GetFolderRandDSchedule (form data)
  • SOAP Action: http://tempuri.org/GetFolderRandDSchedule

Parameters

Parameter Type Required Description
authenticationTicket string Yes Authentication ticket obtained from AuthenticateUser.
Path string Yes Full infoRouter path to the folder (e.g. /Finance/Reports).

Response

Folder Has a Schedule

<root success="true">
  <RetentionDispositionSchedule
    DefId="47"
    Name="Standard 7-Year Retention"
    Description="Retain for 7 years then destroy"
    URL=""
    ReferenceNumber="FIN-001"
    SourceAuthority="IRS"
    RecordsSeriesName=""
    RetentionType="2"
    RetentionTypeText="Temporary"
    RetentionTrigger="1"
    RetentionTriggerText="On Create"
    RetentionPeriodYears="7"
    RetentionPeriodMonths="0"
    RetentionPeriodDays="0"
    DispositionType="1"
    DispositionTypeText="Final Disposition"
    DispositionTrigger="3"
    DispositionTriggerText="Upon Retention End"
    DispositionPeriodYears="0"
    DispositionPeriodMonths="0"
    DispositionPeriodDays="0"
    TransferAgency=""
    MoveFolderId="0"
    MoveFolderPath="" />
</root>

Folder Has No Schedule

<root success="true">
  <RetentionDispositionSchedule DefId="0" />
</root>

Error Response

<root success="false" error="[901]Session expired or Invalid ticket" />

Response Structure

<RetentionDispositionSchedule>

Attribute Description
DefId Schedule definition ID. 0 means no schedule is assigned.
Name Schedule name.
Description Schedule description.
URL External documentation URL.
ReferenceNumber Regulatory reference number.
SourceAuthority Regulatory authority name.
RecordsSeriesName Records series name.
RetentionType 0=None, 1=Permanent, 2=Temporary.
RetentionTypeText Human-readable retention type.
RetentionTrigger 0=Custom Date Entry, 1=On Create, 2=On Cutoff.
RetentionTriggerText Human-readable trigger name.
RetentionPeriodYears / Months / Days Retention period duration.
DispositionType 0=None, 1=Final Disposition, 2=Transfer to External Agency.
DispositionTypeText Human-readable disposition type.
DispositionTrigger 0=Custom Date Entry, 1=On Create, 2=On Cutoff, 3=On Retention End.
DispositionTriggerText Human-readable trigger name.
DispositionPeriodYears / Months / Days Disposition period duration.
TransferAgency Agency name for external transfer.
MoveFolderId Target folder ID for transfer. 0 if not set.
MoveFolderPath Target folder path for transfer.

Required Permissions

Any authenticated user with read access to the folder.

Example

GET Request

GET /srv.asmx/GetFolderRandDSchedule
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &Path=/Finance/Reports
HTTP/1.1
Host: yourserver

POST Request

POST /srv.asmx/GetFolderRandDSchedule HTTP/1.1
Host: yourserver
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&Path=/Finance/Reports

Notes

  • Returns DefId="0" (with no other attributes) when the folder has no R&D schedule assigned.
  • The R&D schedule on a folder applies to the folder itself. Documents inside the folder may have their own separate schedule.
  • To assign a schedule, use SetFolderRandDSchedule.
  • To remove an assigned schedule, use RemoveFolderRandDSchedule.
  • To get the schedule for a document, use GetDocumentRandDSchedule.

Error Codes

Error Description
[900] Authentication failed -" invalid credentials.
[901] Session expired or invalid authentication ticket.
Folder not found No folder was found at the specified Path.