GetRecycleBinContent

# GetRecycleBinContent API

Returns the list of all documents and folders currently in the Recycle Bin of the authenticated user. Each item includes its original path, deletion date, size, the user who deleted it, and a handler value that can be used with PurgeRecycleBinItem or RestoreRecycleBinItem. Use this API to inspect the contents of a user's Recycle Bin before deciding whether to restore or permanently delete items.

Endpoint¶

/srv.asmx/GetRecycleBinContent

Methods¶

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

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

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

Parameters¶

Response¶

Success Response¶

Returns a <response> element with success="true" containing zero or more <document> and <folder> child elements, one per recycled item.

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

  <document

    Name="Q1-2024-Report.pdf"

    DateDeleted="2024-06-15T10:23:45.000Z"

    TotalSize="204800"

    OriginalFolderId="4521"

    DeletePath="/Finance/Reports/Q1-2024-Report.pdf"

    DeletedById="12"

    DeletedByName="jsmith"

    RecycledItemStatusId="0"

    RecycledItemStatus="In User Recycle Bin"

    Handler="D9871" />

  <folder

    Name="OldProjects"

    DateDeleted="2024-06-14T08:10:00.000Z"

    TotalSize="2048000"

    OriginalFolderId="3200"

    DeletePath="/Finance/OldProjects"

    DeletedById="12"

    DeletedByName="jsmith"

    RecycledItemStatusId="0"

    RecycledItemStatus="In User Recycle Bin"

    Handler="F4312" />

</response>

Response Attribute Reference¶

Empty Recycle Bin Response¶

When the bin is empty, the response contains no child elements:

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

Error Response¶

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

Required Permissions¶

Any authenticated user can retrieve their own Recycle Bin contents. The API always returns items belonging to the user identified by the authentication ticket -" it cannot be used to query another user's Recycle Bin.

Example¶

GET Request¶

GET /srv.asmx/GetRecycleBinContent

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

HTTP/1.1

POST Request¶

POST /srv.asmx/GetRecycleBinContent 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:GetRecycleBinContent>

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

    </tns:GetRecycleBinContent>

  </soap:Body>

</soap:Envelope>

Notes¶

• Current User Only: Returns only the items belonging to the authenticated user. There is no filter parameter; all of the user's recycled items are always returned.

• Element Type: Each returned child element is named <document> or <folder> based on the type of the recycled object.

• Handler for Further Actions: The Handler attribute value must be passed to PurgeRecycleBinItem or RestoreRecycleBinItem to operate on individual items.

• RecycledItemStatusId 1 (System Recycle Bin): Items with status 1 have been moved to the system-level recycle bin (typically by an administrator action). They appear in the listing but may require admin action to purge or restore.

• Date Format: DateDeleted is always in UTC ISO 8601 format (yyyy-MM-ddTHH:mm:ss.fffZ).

• TotalSize: Expressed in bytes as a floating-point number rounded to the nearest integer. For folders, this represents the total size of all contents at the time of deletion.

Related APIs¶

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

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

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

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

• DeleteDocument - Delete a document (moves it to the Recycle Bin)

• DeleteFolder - Delete a folder (moves it to the Recycle Bin)

Error Codes¶