Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Checked state of an employee was successfully retrieved.

Body ()

Root Schema : CheckedState

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "enum":[
                "ON_DUTY_ON_SITE",
                "ON_DUTY_OFF_SITE",
                "ON_BREAK_ON_SITE",
                "ON_BREAK_OFF_SITE",
                "OFF_DUTY_ON_SITE",
                "OFF_DUTY_OFF_SITE"
            ]
        },
        "project":{
            "$ref":"#/components/schemas/Project"
        },
        "workShift":{
            "$ref":"#/components/schemas/WorkShift"
        }
    }
}

Nested Schema : Project

Type: object

Show Source

• address(optional): string
  Minimum Length: 0

  Maximum Length: 255

  Address of the project, max length is 255 characters

  Example: 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 project

  Example: Description of my project
• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 53
• links(optional): array links
• name: string
  Minimum Length: 0

  Maximum Length: 255

  Name of the project, cannot be blank, max length is 255 characters

  Example: My project name
• organizationId(optional): string
  Id of the organization

  Example: 52
• startDateTime(optional): string(date-time)
  Project start date/time in ISO-8601 format
• status(optional): string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  Status of the project

  Example: ACTIVE

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "name":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Name of the project, cannot be blank, max length is 255 characters",
            "example":"My project name"
        },
        "description":{
            "type":"string",
            "description":"Detailed description of the project",
            "example":"Description of my project"
        },
        "address":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Address of the project, max length is 255 characters",
            "example":"Oracle Corporation\n500 Oracle Parkway\nRedwood Shores, CA 94065"
        },
        "status":{
            "type":"string",
            "description":"Status of the project",
            "example":"ACTIVE",
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "startDateTime":{
            "type":"string",
            "description":"Project start date/time in ISO-8601 format",
            "format":"date-time"
        },
        "completionDateTime":{
            "type":"string",
            "description":"Expected project completion date/time in ISO-8601 format",
            "format":"date-time"
        },
        "organizationId":{
            "type":"string",
            "description":"Id of the organization",
            "example":"52"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : WorkShift

Type: object

Show Source

• default(optional): boolean
  Read Only: true

  Flag indicating default work shift for newly created projects

  Example: true
• description(optional): string
  Detailed description of the work shift

  Example: Description of work shift
• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 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 characters

  Example: My work shift name
• timeFrom: string(date-time)
  Work shift start time
• timeTo: string(date-time)
  Work shift end time

{
    "required":[
        "name",
        "timeFrom",
        "timeTo"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "name":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Name of the work shift, cannot be blank, max length is 255 characters",
            "example":"My work shift name"
        },
        "description":{
            "type":"string",
            "description":"Detailed description of the work shift",
            "example":"Description of work shift"
        },
        "timeFrom":{
            "type":"string",
            "description":"Work shift start time",
            "format":"date-time"
        },
        "timeTo":{
            "type":"string",
            "description":"Work shift end time",
            "format":"date-time"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "default":{
            "type":"boolean",
            "description":"Flag indicating default work shift for newly created projects",
            "readOnly":true,
            "example":true
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Back to Top