Corpdirsearch - TANDBERG Codec 3000 MXP Reference Manual

Command Information

CorpDirSearch

Command Description
CorpDirSearch
Command to search
for contacts in the
corporate directory
phone book.
Use the CorpDirGetNext
and the ID of the last
entity to search for the
next contacts.
Use the
CorpDirGetPrevious
and the ID of the first
entity to search for the
previous contacts.
Required parameters are identified by an (r) appended to the parameter name. The
D 13887.08
MAY 2008
Parameters
With no parameters specified the
result will show the first 40 catalogs.
Path: <S: 0, 256>
Enter the path, which is the ID of the
folder or subfolder, to search in.
The result will show the first 40
entries in the given catalog. If no
catalog specified by Path, then the
root catalog is used.
Query: <S: 0, 81>
Enter the query to search for.
StartsWith: <S: 0, 81>
The search string should start with.
Hits: <1..40>
Specify the number of hits to show.
SubFolders: <On/Off>
Define if the search should also
include subfolders.
IsFirst: <True/False>
True indicates that this is the first hit
matching the search criteria.
False indicates that this is not the
first hit matching the search criteria.
CorpDirGetPrevious can be used to
search for more contacts.
IsLast: <True/False>
True indicates that this is the last hit
matching the search criteria.
False indicates that this is not the
last hit matching the search criteria.
CorpDirGetNext can be used to
search for more contacts.
(r) appears in this table for your information only and shall not be included when writing the commands – see the column Example for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
Result parameters Result parameters
when OK when error
None As above
148
TANDBERG 3000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Example
xcommand corpdirsearch
*r Result (status=OK):
Entity 1 <type:Catalog>:
Name: "0.1 - Personal Systems"
Path: ""
ID: "138"
IsFirst: True
IsLast: False
Entity 2 <type:Catalog>:
Name: "0.2 - Meeting Rooms"
Path: ""
ID: "140"
IsFirst: False
IsLast: True
*r/end
OK
xcommand corpdirsearch query:charlie
hits:1
*r Result (status=OK):
Entity 1 <type:Entry>:
Name: "charlie.brown"
Path: ""
ID: "29"
IsFirst: True
IsLast: False
ContactInfo 1:
Protocol: H323
CallRate: 384
Restrict: Off
DialString: "123@tandberg.net"
Description: "123@tandberg.net
<H323>"
ContactInfo 2:
Protocol: H320
CallRate: 384
Restrict: Off
DialString: "791"
Description: "791 <ISDN>"
*r/end
OK
& 6000 MXP