PurgeRecycleBinItem

# PurgeRecycleBinItem API

Permanently and irreversibly deletes a single document or folder from the system Recycle Bin. The item is identified by its Handler value, which is obtained from GetRecycleBinContent. Use this API to selectively remove individual items rather than emptying the entire bin. This is an administrator-only operation.

Endpoint¶

/srv.asmx/PurgeRecycleBinItem

Methods¶

• GET /srv.asmx/PurgeRecycleBinItem?AuthenticationTicket=...&ItemHandler=...

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

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

Parameters¶

Response¶

Success Response¶

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

Error Response¶

<response success="false" error="Invalid ItemHandler" />

Partial Failure Response¶

If the item cannot be purged (e.g. a storage error for one file within a folder), a log response is returned:

<response success="false" error="[log]">

  <logitem name="Q1-2024-Report.pdf" message="Unable to delete file from storage." />

</response>

Required Permissions¶

System administrators only. Regular users and domain managers cannot call this API. Attempting to call it as a non-administrator returns a permission error.

Example¶

GET Request¶

GET /srv.asmx/PurgeRecycleBinItem

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

  &ItemHandler=D9871

HTTP/1.1

POST Request¶

POST /srv.asmx/PurgeRecycleBinItem HTTP/1.1

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



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

&ItemHandler=D9871

SOAP Request¶

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

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

  <soap:Body>

    <tns:PurgeRecycleBinItem>

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

      <tns:ItemHandler>D9871</tns:ItemHandler>

    </tns:PurgeRecycleBinItem>

  </soap:Body>

</soap:Envelope>

Notes¶

• Admin Only: The authenticated user must be a system administrator. The check is enforced server-side regardless of how the API is called.

• Irreversible: Once purged, the item is permanently deleted from storage and cannot be recovered. Always confirm the correct ItemHandler before calling.

• Handler Source: The ItemHandler value must be obtained from the Handler attribute of a recycled item returned by GetRecycleBinContent or SearchRecycledItems. Constructing a handler manually (e.g. D9871) is possible but not recommended.

• Handler Format: The prefix letter determines the object type (D = document, F = folder). The prefix is case-insensitive. The numeric part must be a valid integer object ID.

• Invalid Handler: If the ItemHandler string cannot be parsed, or refers to an object type other than document or folder, "Invalid ItemHandler" is returned.

• Item Not Found: If the item no longer exists in the recycle bin (already purged or restored), an error is returned.

• Folder Purge: Purging a folder recursively deletes all documents and sub-folders contained within it. This is a deep, permanent deletion.

• EmptyRecycleBin vs PurgeRecycleBinItem: EmptyRecycleBin removes all items for a specific user but requires the user themselves (not admin). PurgeRecycleBinItem removes a single item and requires admin rights.

Related APIs¶

• GetRecycleBinContent - List recycled items (use to obtain the Handler value)

• SearchRecycledItems - Search for recycled items across all users (admin)

• RestoreRecycleBinItem - Restore a recycled item instead of permanently deleting it

• EmptyRecycleBin - Permanently delete all items in the current user's Recycle Bin

Error Codes¶