WMGetUsersInQueue WMGetUsersInQueueThis call allows fetching the user list depending upon the specified criterion. You can view the XML input and output parameters, which have to be passed for fetching the list and displaying it. 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 |
|
DataFlag |
Root |
It is flag which specifies whether to fetch the data or not |
NA |
|
ProcessDefinitionID * |
Filter |
It refers to the id of the process definition |
NA |
|
QueueID |
Filter |
It is the queue id for which the users are to be fetched. |
NA |
|
ActivityID * |
Filter |
It is the activity id for which the users are to be fetched. |
NA |
|
UserStatus |
Filter |
Logged In or Logged Out status |
Logged In or Logged Out |
|
From |
DateRange |
It is the date from which the user list has to be generated. |
NA |
|
To |
DateRange |
It is the date till which the user list is generated. |
NA |
|
SortOrder |
BatchInfo |
It is the sort order, which can be ascending or descending |
"A"-ascending "D"-descending |
|
OrderBy |
BatchInfo |
It is the field on which the sorting has to be done. |
1=streamid 2=streamname 3=streamcondition |
|
LastValue |
BatchInfo |
It is the last value retrieved.. |
NA |
|
LastIndex |
BatchInfo |
It is the index of the last element retrieved. |
NA |
|
NoOfRecordsToFetch |
BatchInfo |
It is the batch size for streams. |
NA |
|
SessionID |
Root |
It is the logged in user session id. |
NA |
|
GroupID |
Root |
It is the id of the group whose users 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. |
|
ID |
UserInfo |
It is the user id. |
|
Name |
UserInfo |
It is the user name |
|
Personal Name |
UserInfo |
It is the personal name for user. |
|
PersonalQueue Status |
Data |
These value appear only if Data flag is set as "Y". It is the queue status for the user. |
|
SystemAssignedWorkItems |
Data |
It is the count of system assigned workitems |
|
SharedQueueStatus |
Data |
It is the numbers of the shared queue status. |
|
WorkitemsProcessed |
Data |
It is the number of workitems processed by the user. |
|
TotalCount |
Root |
It is the total number of user. |
|
RetrieveCount |
Root |
It is the number of user's retrieved. |
|
FamilyName |
User |
It is the family name. |
|
|
User |
It refers to the email. |
|
Status |
User |
It refers to the status. |
|
QueueAssignment |
User |
It refers to the queue assignment. |
|
SpellingOfRetrievedCount |
User |
It refers to the spelling of the retrieved count. |
|
Code |
Constant Value |
Message |
|
18 |
WM_NO_MORE_DATA |
No more records |
|
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session |