Sign in
time-clock

A simplified clock in and clock out endpoint

This clock in and out endpoint allow an easy implementation for IT departments to link an on promise time clock device to Evolia. It only requires a member code (employee id). If a corresponding shift intersect with the clocked time, this shift is be used to register clock in and clock out values. Otherwise a new unplanned shift will be created.

post/v1/public/time-clock/clock

Request body

memberCodestring required

The member code of the employee clocking in or out

atnumber

A unix timestamp of the clocked time. If not specified the current time is used

teamIdstring

The ID of the team used to match or assign a team to the shift.

If provided: The system looks for a corresponding shift under this team. If none exists, the new shift is linked to this team.

If omitted, the system applies these fallback rules:

  1. Primary Team: Uses the member's primary team (if set).
  2. Single Team: If no primary team is set, but the member belongs to exactly one team, that team is used.
  3. Validation Error: If the member has multiple teams (and no primary), you must explicitly specify a team.
teamCodestring

An optional team, referred by code. See teamId fo more details

locationIdstring

The ID of the location used to match or assign a location to the shift.

If provided: The system looks for a corresponding shift under this location. If none exists, the new shift is linked to this location.

If omitted, the system applies these fallback rules:

  1. Primary Location: Uses the member's primary location (if set).
  2. Single Location: If no primary location is set, but the member belongs to exactly one location, that location is used.
  3. Validation Error: If the member has multiple locations (and no primary), you must explicitly specify a location.
locationCodestring

An optional location, referred by code. See locationId for more details

skillIdstring

The ID of the skill used to match or assign a skill to the shift.

If provided: The system looks for a corresponding shift under this skill. If none exists, the new shift is linked to this skill.

If omitted, the system applies these fallback rules:

  1. Primary Skill: Uses the member's primary skill (if set).
  2. Single Skill: If no primary skill is set, but the member belongs to exactly one skill, that skill is used.
  3. Validation Error: If the member has multiple skill (and no primary), you must explicitly specify a skill.
skillCodestring

An optional skill, referred by code. See skillId for more details

Response

uidstring required

unique event id

externalIdstring

The unique event externalId. The externalId is often used as a mapping value between Evolia and an external system

startsAtstring required

date and time of the start of the event. In ISO-8601 format.

endsAtstring required

date and time of the end of the event. In ISO-8601 format.

hideEndsAtboolean required

if true the event has an undetermined end time. endsAt is still initialised but represent more a suggested end time

timeZonestring required

event time zone, ex: America/New_York

memberFirstNamestring

when assigned, contains the member (employee) first name

memberLastNamestring

when assigned, contains the member (employee) first name

memberIdstring

when assigned, contains the member (employee) UID

memberCodestring

when assigned, contains the member (employee) code

memberHourlyWagenumber

when assigned, contains the member hourly wage specific to the skill of the shift

openShiftCountnumber

a shift is considered open when memberId is undefined. When a shift is open, openShiftCount indicates the number of places available

skillIdstring required

the event skill UID (position)

skillNamestring required

the event skill name (position)

skillCodestring

the event skill code (position)

locationIdstring

the event location UID

locationNamestring

the event location name

locationCodestring

the event location code

subLocationIdstring

the event sub-location UID

subLocationNamestring

the event sub-location name

subLocationCodestring

the event sub-location code

divisionIdstring

the event division UID

teamIdstring required

the event team UID

teamCodestring

the event team code

teamNamestring

the event team name

isStandbyboolean

if true this event is in stand-by

isCancelledboolean

if true this event is cancelled

cancelledReasonstring

the reason of the cancellation

isDraftboolean required

if true this event is draft

notestring

This note is visible to the assigned employee and to shift team managers

internalNotestring

The internalNote field is a private property restricted to shift team managers. This information is never visible to the assigned employee.

paidPreparationTimeInMnumber required

The paid preparation time in minutes.

assignedByobject required

when assigned, member (employee) UID that assigned the event.

assignedAtstring required

when assigned, date and time of the assignment of the event. In ISO-8601 format.

splitFromEventIdstring required

when event is split from another event, contains the source event UID

Example response

{
  "premiums": [
    {
      "names": {
        "en": "night bonus",
        "fr": "prime de nuit"
      },
      "calculationType": "AMOUNT: flat amount (+ 15$), HOURS: flat amount of hours (+ 1h), HOURLY_MULTIPLIER: multiply hourly rate (x 1.5/h), HOURLY_BONUS: flat hourly bonus (+ 1$/h)",
      "code": "241"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.