GET api/users/{id}/role

Retrieves the active role details for a specific user by their ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the user whose active role is to be retrieved.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

On success: HTTP 200 OK with the user's active role details. On failure: HTTP 400 Bad Request if an error occurs or no valid role is found.

RoleDTO
NameDescriptionTypeAdditional information
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: 
{
  "name": "sample string 1",
  "FTE": "sample string 2",
  "actualCost": "sample string 3",
  "startDate": "2025-11-21T03:19:59.6526677+00:00",
  "daysAvailable": "sample string 5",
  "utilisation": "sample string 6"
}