RemoveFolderRandDSchedule API¶

Removes (unassigns) the Retention and Disposition (R&D) schedule from a folder identified by path. Optionally also removes the schedule from all subfolders and/or all documents within the folder hierarchy.

Endpoint¶

/srv.asmx/RemoveFolderRandDSchedule

Methods¶

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

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 folder, or membership of [R&D Managers], which stands in for the right on any folder. Defining schedules themselves is for R&D Managers only. Up to 8.7 the role did not count; the right was required. Removing a folder's schedule also lifts the freeze on the folder and on what it applies to.

Example¶

GET Request -" remove from folder only¶

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

GET Request -" remove from entire folder tree including documents¶

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

POST Request¶

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

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

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 folder, and optionally off what is inside it.

await call('RemoveFolderRandDSchedule', {
  authenticationTicket: ticket,
  Path: '/Finance/Invoices',
  includeFolders: true,
  includeDocuments: true
});

Notes¶

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

Related APIs¶

• SetFolderRandDSchedule -" Assign an R&D schedule to a folder hierarchy.
• GetFolderRandDSchedule -" Get the R&D schedule currently assigned to a folder.
• RemoveDocumentRandDSchedule -" Remove the R&D schedule from a single document.
• DeleteRandDSchedule -" Delete an R&D schedule definition.

Error Codes¶

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