Get Live Shop Floor Clock-Ins (Public API Online Endpoint)
Use the Public API Online resource to read who is currently clocked onto which jobs, steps, and work centers. The data is the same live shop-floor clock-in information that Data Collection maintains and that appears on the Data Collection Current Logins Job Detail grid and in QuickView Data Collection.
For more information see Data Collection.
This resource is read-only. Clock-ins and clock-outs must still be performed in Data Collection. The API does not support POST, PATCH, or DELETE for Online records.
Prerequisites
- Public API access for your company, with a valid bearer token on every request.
- An API user that is allowed to view Shop Floor Control / Data Collection information. Callers without a valid token receive HTTP 401. Callers without the required privilege receive HTTP 403 and should not receive Online data.
For more information see How to Connect to JobBOSS2 Public API for On-Premise Customers.
For more information see Validating JobBOSS2 Public API Credentials for Hosted Customers.
Swagger documentation
The Online endpoints appear in the Swagger UI with other Public API resources (group name Online). Open Swagger from your site (for on-premise installations, typically http://<your-site>/0qmztosk6o/swagger/index.html) or from the hosted integrations documentation at https://integrations.ecimanufacturing.com/.
List currently online employees
Send an HTTP GET to:
{base_url}/api/v1/online
Include the Authorization header:
Authorization: Bearer [token]
A successful request returns HTTP 200 with the standard response envelope. The current Online rows are in the Data array.
{
"Data": [ ... ]
}
Get a single Online record
Send an HTTP GET to:
{base_url}/api/v1/online/{uniqueID}
A successful request returns HTTP 200 with that record. If the unique ID does not exist, the API returns HTTP 404.
Query options
The Online list endpoint supports the same query conventions as other Public API GET resources:
- fields= Comma-separated list of fields to return. If you omit this parameter, the response includes the default Online field set described below.
- sort= Sort by field name. Prefix with + for ascending or - for descending.
- filter Field filters using operators such as [eq], [ne], [gt], [gte], [lt], [lte], [in], [notin], and [null]. Simple equality can omit the operator, for example ?jobNo=7089-02.
- skip= / take= Paging. The default take value follows the Public API maximum (1000 records).
Example: return Online rows for one employee, limited fields:
{base_url}/api/v1/online?employeeCode[eq]=101&fields=employeeCode,jobNo,stepNo,workCntr,logonTime
Default fields
By default an Online response includes the following fields. Date and time values (logonTime and displayLogonTime) are returned in UTC using the format yyyy-MM-ddTHH:mm:ssZ.
| API field | Description |
|---|---|
| employeeCode | Employee currently clocked on |
| jobNo | Job the employee is running |
| stepNo | Routing step |
| workCntr | Work center |
| operCode | Operation code |
| payrollRate | Payroll rate in effect for the clock-in |
| machRun | Machine run indicator |
| cycleHrs | Cycle hours |
| estimHrs | Estimated hours |
| logonTime | Clock-on date and time (UTC) |
| displayLogonTime | Display clock-on date and time (UTC) |
| logonTimerVal | Elapsed logon timer value |
| deviceNo | Data Collection device |
| custCode | Customer on the job |
| breakStart | Break start time, if the employee is on break |
| totalBreakTime | Total break time for the current clock-in |
| pcsRun | Pieces run |
| uniqueID | Unique identifier for the Online row (used in GET by key) |
Typical uses
- Answer “who is running this job right now?” from an external dashboard, MES, or chatbot without querying the database or scraping the Data Collection screen.
- Filter by job, employee, or work center to build a live shop-floor view.
Online rows exist only while employees remain clocked onto a job. After they clock off, the row is no longer returned by this endpoint.