Retrieve a delta

Returns hours to validate requests that have changed since the last delta token.

Caution

Read the Delta page. There is important information on required implementation!

Tip

Check the Swagger page for more technical information on the endpoints.

Endpoint details

GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/hours-to-validate-requests?delta

Headers: Authorization: Bearer {token}, User-Agent: {agent} Scope: connector-protimeapi-hours-to-validate.read

Response properties

Field Type Required Writable Description
changeVersion string — Read-only Property to indicate the order of changes.
id string — Read-only Unique identifier (GUID) for the hours to validate request.
person.id integer — Read-only Internal ID of the person the request applies to.
date string — Read-only Date the requested hours are registered on (YYYY-MM-DD).
durations array — Read-only The durations covered by the request.
durations[].id integer — Read-only Identifier of the requested duration.
durations[].startTimeInMinutes integer — Read-only Start time of the requested duration (minutes since midnight, between -1440 and 2880). Omitted when the duration is not bound to a start time.
durations[].endTimeInMinutes integer — Read-only End time of the requested duration (minutes since midnight, between -1440 and 2880). Omitted when the duration is not bound to an end time.
durations[].durationInMinutes integer — Read-only Requested duration, in minutes.
durations[].originalDurationInMinutes integer — Read-only Duration before the request was raised, in minutes.
status string — Read-only Status of the request. Possible values: Uninitialized, Requested, Deleted, Approved, Refused. An approved request results in a validated hours record.
requested.person.id integer — Read-only Internal ID of the person who raised the request. This can differ from person.id.
requested.requestedAt string — Read-only Date and time the request was raised (ISO 8601 format).
isStale boolean — Read-only Indicates that the request is based on hours to validate that have since been recalculated to a different amount. A stale request can no longer be approved or refused, only deleted.
conversation array — Read-only Comments exchanged on the request. Omitted when no comments were made.
conversation[].person.id integer — Read-only Internal ID of the person who made the comment.
conversation[].commentedAt string — Read-only Date and time the comment was made (ISO 8601 format).
conversation[].comment string — Read-only Text of the comment.

Filters

Filter Type Description
date Required A start date (date ge '...'). An end date is optional; when provided, the range may not exceed 1 year

Note

  • The start date must lie in the past and may not be earlier than January 1st of the previous year
  • The person filter cannot be combined with delta: a delta always covers all people. A request with both returns 400 Bad Request.

External references

The endpoint supports predefined and custom external references. See the external references page for details.

The following collections are supported for this endpoint:

Collection Predefined Custom
people @badge-number, @employee-number Supported

Error responses

Status Condition
400 Invalid filter syntax, unknown filter field, or a person filter combined with delta
401 Missing or invalid access token, or insufficient scope
410 Delta token has expired (older than 72 hours)

Examples

Delta with date filter

Example with a start date:

GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/hours-to-validate-requests?delta&filter=date ge '2025-01-01'

Delta with date range filter

Example with a date range:

GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/hours-to-validate-requests?delta&filter=date ge '2025-01-01' and date le '2025-12-31'

Related pages