Get checked state of an employee.
get
/connectedWorker/clientapi/v2/employees/{employeeId}/checkedState
This operation retrieves current checked state of an employee.
Request
Path Parameters
-
employeeId: string
Employee identifier
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Checked state of an employee was successfully retrieved.
Root Schema : CheckedState
Type:
Show Source
object
-
project(optional):
object Project
-
state(optional):
string
Allowed Values:
[ "ON_DUTY_ON_SITE", "ON_DUTY_OFF_SITE", "ON_BREAK_ON_SITE", "ON_BREAK_OFF_SITE", "OFF_DUTY_ON_SITE", "OFF_DUTY_OFF_SITE" ]
-
workShift(optional):
object WorkShift
Nested Schema : Project
Type:
Show Source
object
-
address(optional):
string
Minimum Length:
0
Maximum Length:255
Address of the project, max length is 255 charactersExample:Oracle Corporation 500 Oracle Parkway Redwood Shores, CA 94065
-
completionDateTime(optional):
string(date-time)
Expected project completion date/time in ISO-8601 format
-
description(optional):
string
Detailed description of the projectExample:
Description of my project
-
id(optional):
string
Read Only:
true
The unique id of the objectExample:53
-
links(optional):
array links
-
name:
string
Minimum Length:
0
Maximum Length:255
Name of the project, cannot be blank, max length is 255 charactersExample:My project name
-
organizationId(optional):
string
Id of the organizationExample:
52
-
startDateTime(optional):
string(date-time)
Project start date/time in ISO-8601 format
-
status(optional):
string
Allowed Values:
[ "ACTIVE", "INACTIVE" ]
Status of the projectExample:ACTIVE
Nested Schema : WorkShift
Type:
Show Source
object
-
default(optional):
boolean
Read Only:
true
Flag indicating default work shift for newly created projectsExample:true
-
description(optional):
string
Detailed description of the work shiftExample:
Description of work shift
-
id(optional):
string
Read Only:
true
The unique id of the objectExample:53
-
links(optional):
array links
-
name:
string
Minimum Length:
0
Maximum Length:255
Name of the work shift, cannot be blank, max length is 255 charactersExample:My work shift name
-
timeFrom:
string(date-time)
Work shift start time
-
timeTo:
string(date-time)
Work shift end time
Nested Schema : Link
Type:
Show Source
object
-
href:
string
The target resource's URI
-
rel:
string
Relation type