Find Method

This method is used to search for existing system entities. One or more fields may be searched in a single search operation with each field having different search criteria applied. The GetFields Method can be used to determine all the available fields to search.

Arguments
  1. string Reference
  2. DataSet RequestDataSet

Reference should contain the Reference returned by the Login Method and is used to identify the user of the Web Service.

RequestDataSet should contain a Parameters DataTable with a single row and the following columns:

and optionally a Sorting DataTable with a single row and the following columns defining how the response results should be sorted:

Note that the fields specified in the Sorting DataTable are independent of those specified in the Parameters DataTable although the same fields may be used in both. The sequence of the columns in the Sorting DataTable dictates the sorting sequence (ie. results are first sorted by the first specified field then, where results for the first field match, the results are further sorted by the second specified field and so on).

Response
  1. DataSet ResponseDataSet

ResponseDataSet will contain a Status DataTable with a single row and the following columns:

and, if successful, a Data DataTable with zero or more rows and the following columns:

Example

The following Web Service call to find all Contacts with a surname of Smith and with christian names starting with S sorted by christian names:

Find("18,23", RequestDataSet)

where RequestDataSet contains the following Parameters DataTable:

Contact Given Names Contact Family Name
S% Smith

and the following Sorting DataTable:

Contact Given Names
Ascending

could produce a DataSet with the following Status DataTable:

Code Text
0 OK

and the following Data DataTable:

Contact ID
200141
200021
200325

where the Contacts are:

Contact ID Contact Given Names Contact Family Name
200141 Sally Smith
200021 Susan Smith
200325 Sylvester Smith