Retrieve a work location
Introduction
You can retrieve a work location 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
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-locations/{workLocationReference}
URL parameters
This parameter needs to be filled in when calling this endpoint.
| Parameter | Description |
|---|---|
<workLocationReference> |
The internal ID or external reference of the work location. |
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 work location. |
name.default |
string | Default name of the work location. |
name.translations |
object | Translated names for supported languages. |
description |
string | Description of the work location. |
External references
It’s possible to use custom external references as a workLocationReference to retrieve a work location. More information can be found on the External References Page
Note
Check the query options below the endpoint on the Swagger page for the relevant external references.
Examples
Retrieve one work location
Example retrieving one work location with internal ID 456:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-locations/456
Retrieve a work location with a custom external reference
Example retrieving a work location with a custom external code 789:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-locations/789?externalReferences=(work-locations,CustomReferenceName)