API Developer Area

Employees

The employee endpoints enable you to create, retrieve, update and delete employees at a given location.

Create/retrieve employees 
/locations/{location_id}/employees/v1

This endpoint enables you to create and retrieve employees at location location_id.

Update/delete employee 
/locations/{location_id}/employees/{employee_id}/v1

This endpoint enables you to update or delete employee employee_id at location location_id.

Employee history 
/locations/{location_id}/employees/history/v2?transponder_id=12345678&transponder_id_source=globus&at=2022-01-07T10:44:12Z

This endpoint retrieves the employee associated with a specific transponder_id at a given location_id. Because transponder IDs may vary in zero-padding depending on their origin, it is recommended to specify the source using the transponder_id_source parameter. Omitting the transponder_id_source may result in ambiguous mappings between transponder IDs and employees, potentially leading to a conflict error (HTTP 409).

If an employee uses an imprinted transponder ID (a 6-character value mapped to an internal transponder ID), you may provide either the imprinted ID or the corresponding internal ID.

Since transponders can be reassigned to different employees over time, you can also use the at parameter to specify the desired point in time for the lookup.

DriverProfile Feature Flag

The driver_profile field is controlled by a feature flag that affects both data retrieval and employee creation/update workflows.

Retrieving employees and employee history

  • Flag deactivated:
    The driver_profile field is not populated.
  • Flag activated:
    The driver_profile field is populated based on the employee’s stored profile.

Creating or updating employees

  • Flag deactivated:

    • The optional driver_profile field is ignored.
    • The system uses the Beginner boolean from the request to derive the stored driver profile:
      • Beginner = true → DriverProfile = Beginner
      • Beginner = false → DriverProfile = Expert

  • Flag activated:

    • If driver_profile is provided:
      Use it directly and ignore the Beginner boolean.
    • If driver_profile is not provided:
      The driver profile is derived from the Beginner boolean:
      • Beginner = true → DriverProfile = Beginner
      • Beginner = false → DriverProfile = Expert

The feature toggle is currently disabled. It will be documented on this page after this change has come into effect.