Access clockings
Introduction
Access clockings refer to records generated when a person uses a terminal to enter or exit a location. These differ from time clockings, as access clockings are always recorded on the actual calendar date and do not involve any previous, current, or next day adjustments.
Properties
| Property | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the access clocking. |
person.id |
integer | Internal ID of the person who performed the clocking. |
date |
string | Date of the access clocking (YYYY-MM-DD). |
timeOfDayInMinutes |
integer | Minutes since midnight (0-1439). Access clockings always occur on the actual date. |
terminal.id |
integer | Internal ID of the terminal where the clocking occurred. |
status |
string | Result of the access attempt (see below). |
Status values
| Value | Description |
|---|---|
AccessOk |
Access granted. |
AccessRefused |
Access denied. |
WrongPinCode |
PIN code verification failed. |
AlarmCode |
Alarm code entered (meaning may depend on configuration). |
AntiPassbackError |
Anti-passback rule violated (e.g., required entry/exit sequence not followed). |
OutZone |
Exited a defined zone (floor plan context; may depend on configuration). |
UnknownBadge |
Badge was unknown at the time of clocking. This can be reprocessed if the badge is later linked to a person, but the status remains UnknownBadge. |
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.
Endpoints
Below you can find the supported endpoints for this data collection.
GET an access clocking by Id
You can retrieve an access clocking by the internal ID using the GET call. Internal IDs for access clockings can be found by listing all access clockings using the GET collection endpoint.
GET https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/access-clockings\{id}
GET a list of access clockings
You can retrieve a list of access clockings using a filter.
GET https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/access-clockings
Filter requirements
- People are optional
- Date range (required with max of 1 year range)
Delta
It’s possible to retrieve changes with the delta. Check the Delta page for more general and critical information on how to use this feature.
Filter requirements when using the delta
- People cannot be used in the delta
- The start date must be a recent date in the past, with the earliest allowed start date being January 1st of the previous year
- The end date isn’t required, when providing an end date there is a max range of 1 year
Example for access clockings with a delta:
GET https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/access-clockings?delta
Webhooks
It’s possible to retrieve change-events with webhooks. Check the Webhooks page for more general and critical information on how to use this feature.
Example for creating a webhook for access clockings:
POST https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/webhooks
{
"destinationUrl": "https://www.fictional-customer.com/protime/access-clockings",
"collectionName": "access-clockings"
}