|
Http Verb |
GET |
|---|---|
|
Url |
/scheduling/r1/clocking-types |
|
Permissions required |
|
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
2024 W2 (FSM 17.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
PAGINATION ORDERING-SERVER-SIDE |
Business Logic
This API returns a list of Scheduling Clocking Types filtered by input criteria.
A scheduling clocking type defines whether a resource has to clock in/out and what happens if it does not. It can be assigned at three levels:
-
the resource
-
the work shift type, as a default
-
the single work shift
It does not represent a single clocking event (e.g., a resource clocking in/out etc.) or what a single clocking event represents (e.g., shift start, shift end, lunch break, etc.). It only states the clocking obligation of the resource or shift.
Available values:
-
NO STAMPING → The resource is not required to clock in/out. No clocking-related checks are applied.
-
STAMPING NO MOBILE OPERATION → The resource must clock in/out. Without a valid clock-in, the resource cannot operate from the mobile app.
-
STAMPING NO ASSIGNMENT OF INTERVENTIONS → The resource must clock in/out. Without a valid clock-in, no interventions can be assigned to the resource.
Query String Parameters
Filter ℹ️
|
Field |
Validations |
Note |
|---|---|---|
|
id |
Max Length: 10 |
|
|
description |
Max Length: 400 |
Wildcard search enabled |
|
code |
Max Length: 40 |
|
Order ℹ️
Default Order
id (ASC)
Possible order values
All response payload fields.
Page ℹ️
Default.
Fields ℹ️
Default.
Header Parameters
Default.
Response documentation
Response payload fields
|
Field |
Note |
|---|---|
|
id |
|
|
description |
|
|
code |
|