Request all user profiles
The method getUserProfiles returns all currently existing user profiles in JobRouter. When this method is used, no data must be passed as a search filter.
Per request the contents of the display settings for the user profiles can be returned.
The return value consists of a list of user profile objects. Through these objects all data and display settings of individual user profiles can easily be accessed.
In case no user profiles exist in JobRouter, an error message will be returned.
Selectively searching for specific user profiles
The method getUserProfiles additionally allows you, next to returning all existing user profiles, to limit the amount of returned user profiles by setting a search filter.
Per request the contents of the display settings for the user profile can be returned.
The return value consists of a list of user profile objects. Through these objects all data and display settings of individual user profiles can easily be accessed.
In case there are no user profiles 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 |
|
includeUserProfileData |
Flag for the advanced profile data to be returned additionally |
Return value: ServiceObject_UserProfile[]; Array with Userprofile objects
