When I Work Shift Breaks API
Two types of breaks are provided. First; Scheduled Shift Breaks are break records associated with scheduled shifts. Second; Shift Breaks are break records associated with time worked.For Shift Breaks (Attendance) Three types of records are possible from a break action or automated action A record can be created from a user break punch allocation A record can be created from a Manager/Supervisor edit to a timesheet. (With this type of record,no break time is generated and only the length is available to be queried.) A Break record can be created via the system configuration setting for Auto-Deduct of Breaks. (Withthis type of record, no break time is generated and only the length is available to be queried.) Note: This endpoint requires the request header for w-userid. For more information about managing Breaks, visit the [Help Center](https://help.wheniwork.com/articles/attendance-settings/)
When I Work Shift Breaks API is one of 22 APIs that When I Work publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 8 JSON Schema definitions.
Tagged areas include Shift Breaks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and 8 JSON Schemas.
This API exposes 6 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://api.wheniwork.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
When I Work Shift Breaks API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JSON Web Token) (W-Token).
By default, every request must be authenticated.
W-Token— Authentication with When I Work is based on a token model using [JSON Web Tokens](https://jwt.io/). First, you authenticate using a private developer key and t…
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Two types of breaks are provided. First; Scheduled Shift Breaks are break records associated with scheduled shifts. Second; Shift Breaks are break records associated with time wor…
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ShiftBreak (14 properties), ScheduledBreak (3 properties), Error (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from When I Work 12
Other APIs When I Work publishes across the network.