WFGetReminder WFGetReminder This call allows fetching reminders for the login user. You can view the XML input and output parameters, which have to be passed for getting reminder . 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 |
NA |
|
OrderBy |
Root |
It is the field by which the reminders are to be displayed. |
Defaults to 1 - Reminder Index 2- Reminder Date Time |
|
SortOrder |
Root |
It is the sorting order for the reminders. |
A for ascending D- descending |
|
LastValue |
Root |
It is the last reminder value |
NA |
|
LastIndex |
Root |
It is the last reminder index |
NA |
|
DataFlag |
Root |
It is flag which specifies whether to fetch the data or not |
NA |
|
NoOfRecordsToFetch |
Root |
It is the batch size for the fetched reminder list |
NA |
|
CurrentDatetime |
Root |
It is the time up to which reminders on specified criteria are to be fetched |
NA |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
It refers to the case sensitive call name. |
|
MainCode |
Exception |
Error code specified by WAPI. |
|
Count |
Root |
Total number of reminders for the login user. |
|
RemIndex |
Reminder |
It is the reminder index |
|
ProcessInstanceId |
Reminder |
It is the process instance for which the reminder is set, |
|
WorkItemId |
Reminder |
It is the workitem id for which the reminder is set. |
|
RemDateTime |
Reminder |
It is the reminder date \time. |
|
SetByUser |
Reminder |
It is the user which has sent the reminder. |
|
RetrievedCount |
Root |
It is the number of reminders which are fetched. |
|
TotalCount |
Root |
It is the number of reminders which are to be displayed in a batch. If it is one greater than the batch size, means there is next batch of reminders. |
|
Comment |
Reminder |
Comment set on the reminder. |
|
Code |
Constant Value |
Message |
|
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session |