plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

Checkin

Checkin

A checkin: one attendance record for one employee, opened when they clock in and closed when they clock out.

View as Markdown
Summary view
CheckinList, 8 fields. What a list returns by default.
Detail view
Checkin, 8 fields. The default for a single read and for every write.
Read with
api:read:checkinsandcheckins::read
Write with
api:write:checkins

A null checked_out_at means the checkin is still open: that is the only thing distinguishing an in-progress day from a finished one, and filter[checked_out_at][null]=true is how a client asks for it. Both timestamps are UTC; rendering them in the employee's own zone is a client concern.

Used by

GETList checkins/checkinsCheckinList
POSTCheck in/checkinsCheckin
GETRead a checkin/checkins/{checkin}Checkin
PATCHCheck out, or correct a checkin/checkins/{checkin}Checkin

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Unique identifier.

user_idintegerServer-assigned

Employee this checkin belongs to. Assigned from the authenticated user on create and never writable.

userRef or UserSummary

The employee this checkin belongs to. Expanding it with ?include=user additionally requires the users::read permission and a token scope covering the users prefix.

checked_in_attimestamp (YYYY-MM-DDThh:mm:ssZ)

When the employee clocked in.

checked_out_attimestamp (YYYY-MM-DDThh:mm:ssZ) or null

When the employee clocked out, or null while the checkin is still open. A null value marks the checkin plnnrly shows as active.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

Variants

CheckinList 8 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

CheckinSummary 2 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: user_id, user, checked_out_at, created_at, updated_at, links

CheckinLinks 1 field

The links object on this resource.

Keys: self