This call sets the preferences for the user. You can view the XML input and output parameters, which have to be passed for setting the preferences. There is a list of errors and warning that can occur in the execution.
* implies for the mandatory parameter.
Name |
Parent Tag |
Description |
Valid Value |
Option * |
Root |
It refers to the case sensitive call name. |
case sensitive call name. |
EngineName * |
Root |
It is the cabinet or database name, which has to be connected. |
NA |
SessionID * |
Root |
It is the logged in user session id. It is an optional parameter |
NA |
OperationFlag* |
Root |
It is the operation flag to define the user's action on database |
I= insert, D=delete, U=update |
ObjectID * |
ObjectInfo |
It is the object id on which the operation is performed. |
NA |
ObjectName * |
ObjectInfo |
It is the name of the object. |
NA |
ObjectType * |
ObjectInfo |
It is the object type |
Q= for saved queries, G= general settings D= search document settings, F= folder search settings. |
NotifyByEmail |
Root |
Whether to notify the User by Email or not. |
Y = Yes N = No |
Data |
Root |
It is the actual data to be saved in user preference. Data is saved in user defined format. |
NA |
Name |
Parent Tag |
Description |
Option |
Root |
It refers to the case sensitive call name. |
MainCode |
Exception |
Error code specified by WAPI. |
ObjectId |
Preferences |
It is the object id for which the settings are changed. |
Code |
Constant Value |
Message |
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session |
15 |
WM_INVALID_FILTER |
The requested filter is invalid. |