Skip to content

GetRandDScheduleInfo API

Returns the full definition of a specific Retention and Disposition (R&D) schedule identified by its numeric ID.

Endpoint

/srv.asmx/GetRandDScheduleInfo

Methods

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

Parameters

Parameter Type Required Description
authenticationTicket string Yes Authentication ticket obtained from AuthenticateUser.
RDDefId integer Yes ID of the R&D schedule definition to retrieve.

Response

Success Response

<root success="true">
  <RetentionDispositionSchedule
    DefId="47"
    Name="Standard 7-Year Retention"
    Description="Retain documents for 7 years then destroy"
    URL="https://regulations.example.com/fin-001"
    ReferenceNumber="FIN-001"
    SourceAuthority="IRS"
    RecordsSeriesName="Financial Records"
    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=""
    CreatedById="1"
    CreatedByName="Admin"
    CreationDate="2024-01-15T09:30:00"
    LastUpdatedById="1"
    LastUpdatedByName="Admin"
    LastUpdatedOn="2024-06-20T14:15:00" />
</root>

Error Response

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

Response Structure

<RetentionDispositionSchedule>

Attribute Description
DefId Schedule definition ID.
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 (when DispositionType=2).
MoveFolderId Target folder ID for transfer. 0 if not set.
MoveFolderPath Target folder path for transfer.
CreatedById User ID of the creator.
CreatedByName Username of the creator.
CreationDate Date and time the schedule was created.
LastUpdatedById User ID of the last updater.
LastUpdatedByName Username of the last updater.
LastUpdatedOn Date and time the schedule was last modified.

Required Permissions

Any authenticated user. Anonymous access is not allowed.

Example

GET Request

GET /srv.asmx/GetRandDScheduleInfo
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &RDDefId=47
HTTP/1.1
Host: yourserver

POST Request

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

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&RDDefId=47

Notes

Error Codes

Error Description
[900] Authentication failed -" invalid credentials.
[901] Session expired or invalid authentication ticket.
Schedule not found No schedule with the specified RDDefId exists.