Retrieve a list
Introduction
You can retrieve a list of absence definitions.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/absence-definitions
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 | Internal unique identifier for the absence definition. |
name.default |
string | Default name value of the absence definition. |
name.translations |
string | A list of translated names of the definition by language code. |
code |
string | An absence code used for this definition. |
friendlyName.default |
string | Default friendly name value for this definition shown to users. |
friendlyName.translations |
string | A list of translated friendly names by language code. |
friendlyCode.default |
string | Default friendly code value for this definition shown to users. |
friendlyCode.translations |
string | A list of translated friendly codes by language code. |
allowedDurations |
array | List of allowed durations (Unknown, FullDay, HalfDay, Interval, Duration). |
isEnabled |
boolean | Indicates if the absence definition is enabled in myProtime. |
isReasonForClocking |
boolean | Indicates if this absence can be used as a reason for clockings. |
absenceGroup.id |
integer | The ID of the associated absence group. |
External references
It’s possible to use custom external references. More information can be found on the External References Page.
The following collections are supported for this endpoint:
| Collection | Predefined | Custom |
|---|---|---|
absence-definitions |
Not available | Supported |
absence-groups |
Not available | Supported |
Examples
Retrieving all absence definitions
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/absence-definitions