Sign in

v1

latestSwagger 2.02026-08-06249.2 KB
ClockEvent

Creates a ClockEvent resource.

post/clock_events

Headers

x-auth-parim-timestampstring required

Current timestamp in seconds.

x-auth-parim-keystring required

The Public API Key for authentication.

X-PARiM-Domainstring required

An internal parameter. Not provided by API consumer.

x-auth-parim-noncestring required

Unique nonce.

x-auth-parim-signaturestring required

The signature string.

Request body

idinteger

Clock event ID. Read-only.

shift_idinteger

ID of the shift the clock event applies to.

user_idinteger

User ID.

action_by_user_idinteger

Created by User ID.

type'clock_in' | 'clock_out' | 'break_start' | 'break_end' | 'check_in' | 'checkpoint_check_in' | 'location_check' required

Clock event type.

timestring date-time

Normalized value of clock event time. Read-only.

latitudenumber

User location latitude at time of clocking. Nullable.

longitudenumber

User location longitude at time of clocking. Nullable.

accuracyinteger

Accuracy of user location in meters at time of clocking. Nullable.

timestampinteger

Normalized (exact time rounded to nearest quarter hour) value of clock event UNIX timestamp in seconds. . Read-only.

exact_timestampinteger

UNIX timestamp in seconds exact time the clock event takes/took place. Defaults to time of request. Nullable.

devicestring

Optional user device description or identifier. Nullable.

Response

ClockEvent resource created

idinteger

Clock event ID. Read-only.

shift_idinteger

ID of the shift the clock event applies to.

user_idinteger

User ID.

action_by_user_idinteger

Created by User ID.

type'clock_in' | 'clock_out' | 'break_start' | 'break_end' | 'check_in' | 'checkpoint_check_in' | 'location_check' required

Clock event type.

timestring date-time

Normalized value of clock event time. Read-only.

latitudenumber

User location latitude at time of clocking. Nullable.

longitudenumber

User location longitude at time of clocking. Nullable.

accuracyinteger

Accuracy of user location in meters at time of clocking. Nullable.

timestampinteger

Normalized (exact time rounded to nearest quarter hour) value of clock event UNIX timestamp in seconds. . Read-only.

exact_timestampinteger

UNIX timestamp in seconds exact time the clock event takes/took place. Defaults to time of request. Nullable.

devicestring

Optional user device description or identifier. Nullable.

All 2 operations