GET api/users/roles?userIds={userIds}
Retrieves active roles for one or more users based on a comma-separated list of user IDs.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userIds |
A comma-separated string of user IDs to retrieve roles for (e.g., "101,102,103"). |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
On success: HTTP 200 OK with a list of active roles for the specified users. On failure: HTTP 400 Bad Request if an error occurs during processing.
UserRoleDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Id of the user with this role |
integer |
None. |
| name |
Role Name |
string |
None. |
| FTE |
Full time equivalent |
string |
None. |
| actualCost |
Actual Cost of this user (e.g. Salary) |
string |
None. |
| startDate |
Date user will start at this role, only relevant for a role change. |
date |
None. |
| daysAvailable |
Days User will be working at this role, format as mon|tue|wed|thu|fri|sat|sun with only relevant days supplied |
string |
None. |
| utilisation |
Target Billable ( number between 0-100 ) |
string |
None. |
Response Formats
application/json, text/json, application/scim+json
Sample:
{
"UserId": 1,
"name": "sample string 2",
"FTE": "sample string 3",
"actualCost": "sample string 4",
"startDate": "2025-11-21T03:18:37.9222052+00:00",
"daysAvailable": "sample string 6",
"utilisation": "sample string 7"
}