searchList Data Type

A search list is used as a dynamic query building object. It is based on a tree structure, of siblings as ORs and children as ANDs.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs description
applyClientPermissions boolean element 1/1 Whether or not to restrict the rows based on the user's composite managed clients (clients user can see)
applyManagedClientPermissions boolean element 1/1 Whether or not to restrict the rows based on the user's managed clients (clients the user manages)
applyUserPermissions boolean element 1/1 Whether or not to restrict the results based on the users the logged in user can see.
asc boolean element 1/1 Whether or not to sort the results in ascending order.
beginIndex int element 0/1 The row number to start retrieving rows.
maxResults int element 0/1 The maximum number of rows to retrieve.
orderByFieldList list of orderByField element 0/unbounded A list of property names to order the results by.
orderByProperty string element 0/1 The property name to order the search by.
propertyList list of searchProperty element 0/unbounded A list of properties to use as search criteria.
retrieveChildClients boolean element 1/1 Whether to have the query retrieve all records for the client's children clients as well as the client.

Example

<searchList>
  <propertyList>
    <op>...</op>
    <propName>...</propName>
    <properties/>
    <value>...</value>
    <suppressAliasing>...</suppressAliasing>
  </propertyList>
  <beginIndex>...</beginIndex>
  <maxResults>...</maxResults>
  <orderByProperty>...</orderByProperty>
  <orderByFieldList>
    <fieldName>...</fieldName>
    <asc>...</asc>
    <complex>...</complex>
  </orderByFieldList>
  <asc>...</asc>
  <applyClientPermissions>...</applyClientPermissions>
  <retrieveChildClients>...</retrieveChildClients>
  <applyManagedClientPermissions>...</applyManagedClientPermissions>
  <applyUserPermissions>...</applyUserPermissions>
</searchList>