SearchRecycledItems API¶

Searches documents and folders across the entire infoRouter Recycle Bin (all users) using optional filter criteria. Returns matching recycled items with the same attributes as GetRecycleBinContent, including the Handler value needed to purge or restore individual items. This is an administrator-only API that provides system-wide visibility into all recycled content. Use it to audit deletion activity, identify items to recover, or build administrative cleanup tooling.

This reads the whole instance's recycled items, not the caller's own. Four of its six filters do not narrow the result the way their names read - see the table under the error codes before relying on one.

Endpoint¶

/srv.asmx/SearchRecycledItems

Methods¶

• GET /srv.asmx/SearchRecycledItems?authenticationTicket=...&objectName=...&dateDeletedMinDate=...&dateDeletedMaxDate=...&minSize=...&maxSize=...&deletedByUsername=...

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

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

Parameters¶

All filter parameters are optional. When all filters are omitted the API returns all recycled items across all users.

Response¶

Success Response¶

Returns a <response> element with success="true" containing zero or more <document> and <folder> child elements matching the filter criteria.

<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="15"

    DeletedByName="admin"

    RecycledItemStatusId="1"

    RecycledItemStatus="In System Recycle Bin"

    Handler="F4312" />

</response>

Response Attribute Reference¶

No Results Response¶

When no items match the filter criteria the response contains no child elements:

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

Error Response¶

<response success="false" error="Only the system administrator can perform this operation." />

Required Permissions¶

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

Example¶

GET Request -" all recycled items (no filters)¶

GET /srv.asmx/SearchRecycledItems

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

HTTP/1.1

GET Request -" items deleted by a specific user in a date range¶

GET /srv.asmx/SearchRecycledItems

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

  &deletedByUsername=jsmith

  &dateDeletedMinDate=2024-06-01

  &dateDeletedMaxDate=2024-06-30

HTTP/1.1

POST Request -" filter by name and size¶

POST /srv.asmx/SearchRecycledItems HTTP/1.1

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

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

&objectName=Report

&minSize=100000

SOAP Request¶

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

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

  <soap:Body>

    <tns:SearchRecycledItems>

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

      <tns:objectName>Report</tns:objectName>

      <tns:dateDeletedMinDate>2024-06-01</tns:dateDeletedMinDate>

      <tns:dateDeletedMaxDate>2024-06-30</tns:dateDeletedMaxDate>

      <tns:minSize>0</tns:minSize>

      <tns:maxSize>0</tns:maxSize>

      <tns:deletedByUsername>jsmith</tns:deletedByUsername>

    </tns:SearchRecycledItems>

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

Searches every recycled item on the instance.

// All six filters have to be present - they are declared as plain strings, so an omitted one is
// an HTTP 400 rather than "no filter". Send an empty string for the ones you do not want.
const root = await call('SearchRecycledItems', {
  authenticationTicket: ticket,
  objectName: 'q3.pdf',
  dateDeletedMinDate: '',
  dateDeletedMaxDate: '',
  minSize: '',
  maxSize: '',
  deletedByUsername: '',
});

Notes¶

• Admin Only: The authenticated user must be a system administrator. The check is enforced server-side.

• System-Wide Search: Unlike GetRecycleBinContent which is scoped to a single user's bin, SearchRecycledItems searches across all users' recycle bins and the system recycle bin.

• All Filters Optional: Calling with only authenticationTicket returns every recycled item in the system. Add filters to narrow results.

• ObjectName is an Exact Match Unless It Has a Wildcard: objectName=Report finds only an item named exactly Report. Use * for a partial match: *Report* finds any name containing it. (This page used to say the filter was a substring match; it never was.)

• Paging: This call returns every match at once. SearchRecycledItems1 returns them a page at a time, sorted, with the total.

• Date Filters: Both dateDeletedMinDate and dateDeletedMaxDate can be sent in UTC -" the server automatically converts them to local time for comparison. Either bound can be omitted independently.

• Size Filters: minSize and maxSize are in bytes. A value of 0 is treated as "no filter" for that bound. For folder items the size represents the total content size at the time of deletion.

• deletedByUsername Must Exist: If the username provided does not match any existing user, an error is returned rather than an empty result.

• Handler for Actions: The Handler attribute in each result can be passed directly to PurgeRecycleBinItem or RestoreRecycleBinItem.

Related APIs¶

• GetRecycleBinContent - List all items in the current user's own Recycle Bin (no filters, non-admin)

• PurgeRecycleBinItem - Permanently delete a single Recycle Bin item by handler (admin only)

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

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

Error Codes¶

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

An item in the bin is named by its handler: the letter D and a document id, or the letter F and a folder id - D4512, F183. It is read off the Handler attribute of an item returned by GetRecycleBinContent or SearchRecycledItems; there is no other way to build one, because the ids are not the ones a caller sees anywhere else.

The filters¶

Both size bounds were broken until 9.0: they were multiplied by an internal unit that defaulted to zero and that nothing ever set, so minSize meant "at least 0 bytes", which is every item, and maxSize meant "at most 0 bytes", which left out a 208 byte document. They count bytes now.