Search

# Search API

Prepares a search result set using criteria provided in XML format. The search is executed server-side and the results are stored in the user's session. Use GetNextSearchPage and GetPreviousSearchPage to page through the results after calling Search.

Endpoint¶

/srv.asmx/Search

Methods¶

• GET /srv.asmx/Search?authenticationTicket=...&xmlcriteria=...&SortBy=...&AscendingOrder=...
• POST /srv.asmx/Search (form data)
• SOAP Action: http://tempuri.org/Search

Parameters¶

Sort Field Values¶

XML Criteria Reference¶

The xmlcriteria parameter must be a well-formed XML document. The root element may have any name; each child <criteria> element defines one search condition.

Envelope:

<criteria>
  <criteria NAME="..." OPERATOR="..." VALUE="..." />
  ...
</criteria>

Each element uses three attributes:

Supported Criteria Elements¶

Date Criteria Subtypes¶

The DATECRITERIA element requires a SUBTYPE attribute to specify which date field to filter by:

Example:

<criteria NAME="DATECRITERIA" OPERATOR="EQGT" SUBTYPE="CREATED" VALUE="2025-01-01" />
<criteria NAME="DATECRITERIA" OPERATOR="BETWEEN" SUBTYPE="MODIFIED" VALUE="2024-01-01|2024-12-31" />

Document Language Values¶

The DOCLANG criterion accepts the following ISO 639-1 language codes:

en, de, es, fr, da, el, et, he, hi, hu, id, it, ja, ko, nl, no, pl, pt, ro, ru, sv, tk, tr, uk, ur, uz, vi, zh

Property Set Criteria¶

To filter by a custom property set, use the PROPERTYSETNAME element with child elements for each field:

<criteria NAME="PROPERTYSETNAME" VALUE="MyPropertySet">
  <criteria NAME="FieldName" OPERATOR="LIKE" VALUE="Annual Report" />
  <criteria NAME="Amount"    OPERATOR="EQGT" VALUE="1000" />
</criteria>

Supported operators per field data type:

Response¶

Search prepares the result set and stores it in the session. The response confirms the query was accepted and includes metadata about the total result counts.

Success Response¶

<root success="true" ranksorted="false" />

After a successful Search call, use GetNextSearchPage to retrieve the first page of results.

Error Response¶

<root success="false" error="[ErrorCode] Error message" />

Required Permissions¶

Any authenticated user may call this API. Results are automatically filtered to items the user has at least Read permission for. Read-only users may also use this API.

Example¶

GET Request¶

GET /srv.asmx/Search?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &xmlcriteria=%3Ccriteria%3E%3Ccriteria+NAME%3D%22KEYWORDS%22+VALUE%3D%22annual+report%22%2F%3E%3C%2Fcriteria%3E
  &SortBy=MODIFICATIONDATE
  &AscendingOrder=false
HTTP/1.1

POST Request¶

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&xmlcriteria=<criteria>
    <criteria NAME="FOLDER"            VALUE="/Finance/Reports" />
    <criteria NAME="INCLUDESUBFOLDERS" VALUE="true" />
    <criteria NAME="DATECRITERIA"      OPERATOR="EQGT" SUBTYPE="MODIFIED" VALUE="2025-01-01" />
    <criteria NAME="SEARCHFOR"         VALUE="DOCUMENTSONLY" />
  </criteria>
&SortBy=MODIFICATIONDATE
&AscendingOrder=false

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:Search>
      <tns:authenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:authenticationTicket>
      <tns:xmlcriteria>&lt;criteria&gt;
        &lt;criteria NAME="KEYWORDS" VALUE="annual report"/&gt;
      &lt;/criteria&gt;</tns:xmlcriteria>
      <tns:SortBy>MODIFICATIONDATE</tns:SortBy>
      <tns:AscendingOrder>false</tns:AscendingOrder>
    </tns:Search>
  </soap:Body>
</soap:Envelope>

Full Criteria Example — Advanced Search¶

<criteria>
  <criteria NAME="SEARCHSCOPE"       VALUE="ONLINE" />
  <criteria NAME="KEYWORDS"          VALUE="quarterly budget" />
  <criteria NAME="FOLDER"            VALUE="/Finance/Reports" />
  <criteria NAME="INCLUDESUBFOLDERS" VALUE="true" />
  <criteria NAME="SEARCHFOR"         VALUE="DOCUMENTSONLY" />
  <criteria NAME="DATECRITERIA"      OPERATOR="BETWEEN" SUBTYPE="MODIFIED" VALUE="2024-01-01|2024-12-31" />
  <criteria NAME="IMPORTANCE"        OPERATOR="EQ" VALUE="HIGH" />
  <criteria NAME="PUBLISHSTATUS"     VALUE="2" />
  <criteria NAME="PROPERTYSETNAME"   VALUE="ProjectMetadata">
    <criteria NAME="Department" OPERATOR="EQ"   VALUE="Finance" />
    <criteria NAME="Budget"     OPERATOR="EQGT" VALUE="50000" />
  </criteria>
</criteria>

User-Scoped Search Examples¶

<!-- Items subscribed to by a user -->
<criteria>
  <criteria NAME="SUBSCRIPTIONSOF" VALUE="jsmith" />
</criteria>

<!-- Items in a user's favorites -->
<criteria>
  <criteria NAME="FAVORITESOF" VALUE="jsmith" />
</criteria>

<!-- Current user's recent documents -->
<criteria>
  <criteria NAME="RECENTDOCUMENTS" />
</criteria>

<!-- Items in a user's download queue -->
<criteria>
  <criteria NAME="DOWNLOADQUEOF" VALUE="jsmith" />
</criteria>

Notes¶

• The Search API only prepares the result set; it does not return document listings. Call GetNextSearchPage immediately after to retrieve the first page.
• Result sets are stored server-side in the user's session and expire with the session (30-day sliding window).
• Passing an empty string for xmlcriteria returns all documents and folders accessible to the user, subject to permissions.
• Passing an empty string for SortBy uses the system default sort (by document name, ascending).
• Full-text search (KEYWORDS) requires a content search service (Windows Search, DTSearch, or Remote Search) to be configured and running. If no content search service is available, keyword searches return only metadata matches.
• The DATECRITERIA value for BETWEEN uses a pipe (|) separator: startDate|endDate in yyyy-MM-dd format.
• The DATECRITERIA operator EQLT means "on or before the given date"; EQGT means "on or after the given date"; EQ means exactly on the given date.
• The CHECKOUTSTATUS value CHECKEDOUTBYUSER requires an additional USERNAME attribute on the same element specifying the target user's login name.
• The VIEWCRITERIA criterion can optionally include a USERNAME attribute to filter by another user's view history (requires appropriate permissions).
• The SUBSCRIPTIONSOF, FAVORITESOF, and DOWNLOADQUEOF criteria require the VALUE attribute to be a valid infoRouter username; an error is returned if the user is not found.
• The RECENTDOCUMENTS criterion returns recent documents for the currently authenticated user only; no VALUE attribute is required.
• Property set field names are case-insensitive, but the property set name must match an existing definition in the system.

Related APIs¶

• GetNextSearchPage - Retrieves the next page of the prepared search results
• GetPreviousSearchPage - Retrieves the previous page of the prepared search results
• GetFoldersAndDocuments - Lists documents and folders in a specific path without a search query
• GetDocuments - Returns documents in a specific folder path

Error Codes¶

For detailed documentation visit: https://support.inforouter.com/api-docs/Search