Skip to content

Start employees shift.

Request

Start employee shift. If the employee shift has already been started via web browser, mobile app or any other terminal, the request is ignored and the method returns status 200.

Client application should send request immediately when event occurs. If there is any problem with connection or access to API event should be queued in clients side and then sent in order of occurence.

Before you can use this method, please:

  1. Configure 'API Terminal' in Calamari Clockin configuration panel
  2. Make sure API access is enabled


Expect error codes:
  1. INVALID_EMPLOYEE - when invalid employee id provided
  2. INVALID_TIME - when invalid event time provided
  3. API_TERMINAL_NOT_AVAILABLE - no API terminal configured or the employee doesn't have access to this terminal

Security
basicAuth
Bodyapplication/json
personstringrequired

Employee identifier. You can use e-mail or external identifier in format (externalNumber:ABC123)

Example:"john.white@mycompany.com"
timestring, (date-time)required

Date and time of event occurence in ISO format.

projectIdinteger, (int64)

Project id.

Example:1
descriptionstring

Description

Example:"Example description"
curl -i -X POST \
  -u '<username>:<password>' \
  https://awesome-company.calamari.io/api/clockin/terminal/v1/clock-in \
  -H 'Content-Type: application/json' \
  -d '{
    "person": "john.white@mycompany.com",
    "time": "2019-08-24T14:15:22Z",
    "projectId": 1,
    "description": "Example description"
  }'

Responses

successful operation

Bodyapplication/json
personobject(Person)required

Employee description

shiftStatusstringrequired

Employee shift status after request

Enum:"STARTED""FINISHED"
Response
{
  "person": {
    "firstName": "John",
    "lastName": "White"
  },
  "shiftStatus": "STARTED"
}