Methods

Resource

{
    "breaks": [
        {
            "endTimeLocal": "date-time",
            "endTimeUtc": "date-time",
            "isPaidBreak": "boolean",
            "startTimeLocal": "date-time",
            "startTimeUtc": "date-time"
        }
    ],
    "classificationId": "int32",
    "classificationName": "string",
    "dimensionValues": [
        {
            "id": "int32",
            "name": "string",
            "reportingDimensionId": "int32"
        }
    ],
    "employee": {
        "breakStartTimeUtc": "date-time",
        "clockOnTimeUtc": "date-time",
        "currentShiftId": "int32",
        "employeeGroupIds": [
            "int32"
        ],
        "employeeId": "int32",
        "employeeStartDate": "date-time",
        "firstName": "string",
        "hasEmail": "boolean",
        "longShift": "boolean",
        "mobileNumber": "string",
        "name": "string",
        "profileImageUrl": "string",
        "recordedTimeUtc": "date-time",
        "status": "string",
        "surname": "string"
    },
    "endTimeLocal": "date-time",
    "endTimeUtc": "date-time",
    "id": "int32",
    "kioskId": "int32",
    "kioskName": "string",
    "locationFullyQualifiedName": "string",
    "locationId": "int32",
    "shiftConditions": [
        {
            "id": "int32",
            "name": "string"
        }
    ],
    "startTimeLocal": "date-time",
    "startTimeUtc": "date-time",
    "timesheetLineId": "int32",
    "workTypeId": "int32",
    "workTypeName": "string"
}

Properties

Name Type Description
breaks[] array
breaks[].endTimeLocal date-time Nullable
breaks[].endTimeUtc date-time Nullable
breaks[].isPaidBreak boolean Boolean
breaks[].startTimeLocal date-time DateTime
breaks[].startTimeUtc date-time DateTime
classificationId int32 Nullable
classificationName string String
dimensionValues[] array
dimensionValues[].id int32 Int32
dimensionValues[].name string String
dimensionValues[].reportingDimensionId int32 Int32
employee object BasicKioskEmployeeModel
employee.breakStartTimeUtc date-time Nullable
employee.clockOnTimeUtc date-time Nullable
employee.currentShiftId int32 Nullable
employee.employeeGroupIds[] array of int32
employee.employeeId int32 Int32
employee.employeeStartDate date-time Nullable
employee.firstName string String
employee.hasEmail boolean Boolean
employee.longShift boolean Boolean
employee.mobileNumber string String
employee.name string String
employee.profileImageUrl string String
employee.recordedTimeUtc date-time Nullable
employee.status string TimeAttendanceStatus

Possible values are:

  • NotClockedOn
  • ClockedOn
  • OnBreak
  • ClockedOff
employee.surname string String
endTimeLocal date-time Nullable
endTimeUtc date-time Nullable
id int32 Int32
kioskId int32 Int32
kioskName string String
locationFullyQualifiedName string String
locationId int32 Int32
shiftConditions[] array
shiftConditions[].id int32 Int32
shiftConditions[].name string String
startTimeLocal date-time DateTime
startTimeUtc date-time DateTime
timesheetLineId int32 Nullable
workTypeId int32 Nullable
workTypeName string String