RemoveDocumentRandDSchedule API¶

Removes (unassigns) the Retention and Disposition (R&D) schedule from a document identified by path. After this call the document has no R&D schedule.

Endpoint¶

/srv.asmx/RemoveDocumentRandDSchedule

Methods¶

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

Parameters¶

Response¶

Success Response¶

<response success="true" />

Error Response¶

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

Required Permissions¶

Either the change retention period right on the document, or membership of [R&D Managers], which stands in for the right on any document. Defining schedules themselves is for R&D Managers only. Up to 8.7 a schedule other than the folder's needed the right and the role.

Example¶

GET Request¶

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

POST Request¶

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

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

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Takes the schedule off a document. It is SetDocumentRandDSchedule with RDDefId="0", and it is safe to repeat - a document that has no schedule is a success.

await call('RemoveDocumentRandDSchedule', {
  authenticationTicket: ticket,
  Path: '/Finance/Invoices/inv-1001.pdf'
});

Notes¶

• If the document has no schedule assigned, the call succeeds without error (no-op).
• Removing a schedule clears the computed retention and disposition dates from the document.
• This operation is required before deleting the schedule definition via DeleteRandDSchedule if the schedule is assigned to documents.
• To assign a schedule, use SetDocumentRandDSchedule.
• To remove a schedule from a folder hierarchy, use RemoveFolderRandDSchedule.

Related APIs¶

• SetDocumentRandDSchedule -" Assign an R&D schedule to a document.
• GetDocumentRandDSchedule -" Get the R&D schedule currently assigned to a document.
• RemoveFolderRandDSchedule -" Remove the R&D schedule from a folder hierarchy.
• DeleteRandDSchedule -" Delete an R&D schedule definition.

Error Codes¶

The errorCode values this operation returns, checked against a running server: