Retrieve an absence

Introduction

You can retrieve an absence by the internal ID using the GET call.

Endpoint details

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/absences/{id}

URL parameters

This parameter needs to be filled in when calling this endpoint.

Parameter	Description
<id>	The internal ID of the absence.

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 absence instance.
person.id	integer	Internal ID of the person for whom the absence is registered.
resultingAbsenceDefinition.id	integer	Internal ID of the resulting absence definition.
requestedAbsenceDefinition.id	integer	Internal ID of the originally requested absence definition.
shiftDefinition.id	integer	Internal ID of the shift definition for the absence.
date	string	Date of the absence (YYYY-MM-DD).
startTimeInMinutes	integer	Start time of the absence in minutes since midnight.
durationInMinutes	integer	Duration of the absence in minutes.
calculatedDurationInMinutes	integer	Calculated duration of the absence in minutes.
dayPart	string	Part of the day the absence applies to (First, Second, Unknown).
request.id	string	ID of the related absence request, formatted as {TenantId}-{PersonId}-{RequestId}.
status	string	How the absence was registered (Manual, Auto, BeginOpen, Open, Terminal, Calendar).
approvalLevel	string	Approval status (Approved, NotApproved, NotApprovedByPriorities, NotApprovedByCalculations, AwaitingApproval).
isLocked	boolean	Indicates if the absence is locked and cannot be changed.
periodType	string	Type of period the absence applies to (Unknown, Day, Week, PayPeriod).

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.

Good to know

Shift definition behaviour

The shiftDefinition property is typically linked to the absence, unless the shift is inherited from the schedule.

Examples

Retrieving an absence

Example with an absence ID 905165:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/absences/905165

With external reference

Example with external reference for the absence definition:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/absences/905165?externalReferences=(absence-definitions,@absence-code)