Directory.Search

Searches the specified directory for the specified entries.

Parameters

Directory.id (Required)

Specifies the identifier of the directory to search.

Directory.queryCount

Specifies how many directory items to retrieve.

Directory.queryType

Specifies whether to query from the beginning of the list or the current position:

  • AddressBook.queryFirstDEFAULT
  • AddressBook.queryNext
Directory.queryFirst

Specifies the first name to use for the query.

Directory.queryLast

Specifies the last name to use for the query.

User.context (Required)

Specifies the context identifier for this user's session.

Returns

The following table lists return values along with descriptions.

Directory.hasMore

There are more matches than were returned.

Directory.id

Identifier for the directory that was searched.

Directory.Item.count

Number of items returned from the search.

Directory.Item[n].id

Identifier of the nth item.

Directory.Item[n].email

Email address of the nth item.

Directory.Item[n].emailDisplay

Displayable version of the email address of the nth item.

Directory.Item[n].type

Item type of the nth item.

Directory.Item[n].name

Full name of the nth item.

Directory.Item[n].firstName

First name of the nth item.

Directory.Item[n].lastName

Last name of the nth item.

Directory.Item[n].phone

Telephone number of the nth item.

Directory.Item[n].fax

Fax number of the nth item.

Directory.Item[n].department

Department of the nth item.

Directory.Item[n].title

Title of the nth item.

Directory.name

Name of the directory that was searched.

Directory.isEmpty

Specifies if the directory is empty.

Directory.isReadOnly

Specifies if you have only read access to this directory.

Example

<FORM method=post action=/servlet/webacc>
   <INPUT type="hidden" name="User.context" value="xyz">
   <INPUT type="hidden" name="action" value="Directory.Search">
   <INPUT type="hidden" name="Directory.id" 
          value="Frequent Contacts">
   <INPUT type="input" name="Directory.queryFirst" value="">
   <INPUT type="input" name="Directory.queryLast" value="">
   <INPUT type="submit" name="submit" value="Search">
</FORM>