Skip to main content

system.mes.shift.getShiftStatus

Description

Retrieves the status of a Shifts. It evaluates the most recent shift record to determine the current status.

Permissions

This method requires the SHIFT.READ.GET permission.

Syntax

system.mes.shift.getShiftStatus(id)

Parameters

ParameterTypeNullableDescription
idString (ULID)FalseThe ID of the shift to inspect.

Returns

Returns a String (Enum) representing the status. Possible values include: IDLE, ACTIVE, CLOSED, VERIFIED.

Code Examples

status = system.mes.shift.getShiftStatus('01JAP8RJBN-8ZTPXSGY-J9GSDPE1')
print(status)