Retrieve an activity duration
Introduction
You can retrieve an activity duration by the internal ID using the GET call. Internal IDs for activity durations can be found by listing all activity durations using the GET collection endpoint.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/activity-durations/{id}
URL parameters
This parameter needs to be filled in when calling this endpoint.
| Parameter | Description |
|---|---|
<id> |
The internal ID of the activity duration. IDs are available in the location header after a successful POST call. |
Response properties
This list of properties is returned by this endpoint.
| Property | Type | Description |
|---|---|---|
changeVersion |
string | Property to indicate the order of changes. |
id |
integer | Unique identifier for the activity duration. |
person.id |
integer | Unique identifier of the person linked to this duration. |
date |
string | Date of the activity duration (YYYY-MM-DD). |
durationInMinutes |
integer | Duration in minutes for the activity. |
activityLevels.level |
integer | A list of levels in the activity structure of the registered activity definition. |
activityLevels.activityDefinition.id |
string | Unique identifier for the activity definition registered. |
absenceDefinition.id |
integer | Unique identifier for the absence definition, if an absence is linked to the duration. |
request.id |
string | Unique identifier for the request, if the duration was requested. |
counterDefinitions.id |
integer | A list of unique identifiers for the counter definitions or multiple definitions, if one or more counters are linked to this duration. |
shiftDefinition.id |
integer | Unique identifier for the shift definition, if a shift is linked to the duration. |
status |
string | Status of the activity duration (Unknown, Auto, Manual). |
isAuthorized |
boolean | Indicates if the activity duration is authorized. |
External references
It’s possible to use predefined external references and custom external references. More information can be found on the External References Page
For a list of predefined external references, see the external reference options section.
Note
Check the query options below the endpoint on the Swagger page for the relevant external references.
Good to know
Shift definition behaviour
The shiftDefinition property is typically linked to the activity duration, unless the shift is inherited from the schedule.
Tip
In cases where the shift comes from the schedule, the shiftDefinition is not included in the response. If the shift isn’t inherited from the schedule, the shiftDefinition will be included in the response.
Examples
With an external reference
An example retrieving an activity duration by ID 123 with external references:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/activity-durations/123?externalReferences=(people,@employee-number)(activity-definitions,@data-entry-code)