apidocs

SetDocumentRandDSchedule API

Assigns a Retention and Disposition (R&D) schedule to a document identified by path. The schedule controls how long the document must be retained and what happens when the retention period expires.

Endpoint

/srv.asmx/SetDocumentRandDSchedule

Methods

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

Parameters

Parameter	Type	Required	Description
authenticationTicket	string	Yes	Authentication ticket obtained from AuthenticateUser.
Path	string	Yes	Full infoRouter path to the document (e.g. /Finance/Reports/Q1.pdf).
RDDefId	integer	Yes	ID of the R&D schedule definition to assign. Must be > 0. Use GetRandDSchedules to find valid IDs.

Response

Success Response

<root success="true" />

Error Response

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

Required Permissions

The calling user must have write access to the document.

Example

GET Request

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

POST Request

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

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&Path=/Finance/Reports/Q1-2024.pdf&RDDefId=47

Notes

• Assigning a schedule triggers the calculation of the document’s retention end date and disposition date based on the schedule settings and the document’s creation date or cutoff date.
• If the document already has a schedule assigned, it is replaced with the new one.
• To remove a schedule from a document without replacing it, use RemoveDocumentRandDSchedule.
• To assign a schedule to an entire folder hierarchy, use SetFolderRandDSchedule.

Related APIs

• GetDocumentRandDSchedule -“ Get the R&D schedule currently assigned to a document.
• RemoveDocumentRandDSchedule -“ Remove the R&D schedule from a document.
• SetFolderRandDSchedule -“ Assign a schedule to a folder hierarchy.
• GetRandDSchedules -“ List all R&D schedule definitions with their IDs.
• CreateRandDSchedule -“ Create a new R&D schedule definition.

Error Codes

Error	Description
[900]	Authentication failed -“ invalid credentials.
[901]	Session expired or invalid authentication ticket.
Access Denied	Caller does not have write access to the document.
Document not found	No document was found at the specified Path.
Schedule not found	No R&D schedule with the specified RDDefId exists.