Retrieve a work interruption
Introduction
You can retrieve a work interruption by its internal ID using the GET call. Internal IDs for work interruptions can be found by listing all work interruptions using the GET collection endpoint.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-interruptions/{id}
URL parameters
This parameter needs to be filled in when calling this endpoint.
| Parameter | Description |
|---|---|
<id> |
The internal ID of the work interruption. |
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 work interruption record. |
person.id |
integer | Internal ID of the person this work interruption belongs to. |
date |
string | Date for which the work interruption is recorded (YYYY-MM-DD). |
durationInMinutes |
integer | Duration of the work interruption in minutes. |
startTimeInMinutes |
integer | Start time of the work interruption (minutes since midnight). |
endTimeInMinutes |
integer | End time of the work interruption (minutes since midnight). |
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.