Request all users
The method getUsers returns all currently existing users in JobRouter. When this method is used, no data must be passed as a search filter.
Per request, the contents of the user-defined fields of the user as well as the global user rights can be returned.
The return value consists of a list of user objects. Through these objects all data, user-defined fields and user rights of the individual users can easily be accessed.
In case no users exist in JobRouter, an error message will be returned.
Selectively searching for a specific user
The method getUsers additionally allows you, next to returning all existing users, to limit the amount of returned users by setting a search filter.
Per request, the contents of the user-defined fields of the user as well as the global user rights can be returned.
The return value consists of a list of user objects. Through these objects all data, user-defined fields and user rights of the individual users can easily be accessed.
In case there are no users found that match the search filter criteria during the request, an error message will be returned.
Method reference
Parameters |
Data type |
Description |
|---|---|---|
kvpList |
Array with the search data as key value pair. |
|
includeCustomUserData |
Flag for the content of user defined fields to be additionally returned |
|
includeUserRights |
Flag for the user rights to be additionally returned |
Return value: ServiceObject_User[]; Array with user objects
