Retrieve historical fields
Introduction
You can retrieve historical field information for one person by the internal ID or an external reference using the GET call.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people/{PersonReference}/{HistoricalFieldCategoryIdentifier}-history
URL parameters
These parameters need to be filled in when calling this endpoint.
| Parameter | Description |
|---|---|
<PersonReference> |
The internal ID or external reference of the person. |
<HistoricalFieldCategoryIdentifier> |
The identifier of the historical field category (see table below). |
Response properties
This list of properties is returned by this endpoint.
| Property | Type | Description |
|---|---|---|
id |
integer | Internal unique identifier for the historical field record. |
changeVersion |
string | Property to indicate the order of changes. |
person.id |
integer | Internal unique identifier for the person. |
from |
string | Start date of the historical field record (YYYY-MM-DD). |
until |
string | End date of the historical field record (if applicable; until infinity if empty) (YYYY-MM-DD). |
historicalFieldCategory.id |
integer | Unique identifiers for the historical field catalog record. |
Historical field categories
The options for currently supported historical field categories are the following:
| Category | Identifier |
|---|---|
| departments | department |
| employers | employer |
| jobs | job |
| job categories | job-category |
| sectors | sector |
| work locations | work-location |
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.
Caution
There are some restrictions on the characters allowed in URL requests. See the fetching resources page for more information.
Examples
Retrieving department history for a person
Example to request the history of departments for person 1238:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people/1238/department-history
Retrieving employer history for a person
Example to request the history of employers for person 1238:
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/people/1238/employer-history