EmptyRecycleBin API¶

Permanently deletes all items in the Recycle Bin of the currently authenticated user. Once emptied, the items cannot be recovered. Use this API to programmatically clean up a user's recycle bin as part of maintenance routines or end-of-period housekeeping.

Endpoint¶

/srv.asmx/EmptyRecycleBin

Methods¶

• GET /srv.asmx/EmptyRecycleBin?AuthenticationTicket=...

• POST /srv.asmx/EmptyRecycleBin (form data)

• SOAP Action: http://tempuri.org/EmptyRecycleBin

Parameters¶

Response¶

Success Response¶

<response success="true" error="" />

Error Response¶

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

Required Permissions¶

Any authenticated user can empty their own Recycle Bin. A user cannot empty another user's Recycle Bin -" the operation is always scoped to the authenticated user identified by the ticket.

Example¶

GET Request¶

GET /srv.asmx/EmptyRecycleBin

  ?AuthenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

HTTP/1.1

POST Request¶

POST /srv.asmx/EmptyRecycleBin HTTP/1.1

Content-Type: application/x-www-form-urlencoded

AuthenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

               xmlns:tns="http://tempuri.org/">

  <soap:Body>

    <tns:EmptyRecycleBin>

      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>

    </tns:EmptyRecycleBin>

  </soap:Body>

</soap:Envelope>

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;
}

Destroys everything in the caller's recycle bin. There is no undo and no report of what went.

// Read the bin first - this is the only chance to know what is about to be destroyed.
const doomed = await call('GetRecycleBinContent', { authenticationTicket: ticket });
await call('EmptyRecycleBin', { authenticationTicket: ticket });

Notes¶

• Irreversible: Once the recycle bin is emptied, all deleted documents and folders are permanently removed and cannot be recovered.

• Current User Only: The API operates solely on the recycle bin of the user who owns the authentication ticket. There is no parameter to target another user's recycle bin.

• Empty Bin is Not an Error: If the recycle bin is already empty, the API returns success="true" without error.

• Admin Recycle Bin: System administrators with access to the admin recycle bin must use the administration interface to empty other users' bins; this API cannot do so.

• Selective Deletion: To permanently delete individual items rather than the entire bin, use PurgeRecycleBinItem.

• Restore Before Empty: To recover items before emptying, use RestoreRecycleBinItem first.

Related APIs¶

• GetRecycleBinContent - List all items currently in the user's Recycle Bin

• PurgeRecycleBinItem - Permanently delete a single item from the Recycle Bin

• RestoreRecycleBinItem - Restore a Recycle Bin item to its original or a specified location

• SearchRecycledItems - Search for documents and folders in the Recycle Bin

Error Codes¶

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