Check Employee

If the specified employee has kiosk access, returns details about the employee and their current shift.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/kiosk/{kioskId}/checkid

Path parameters

Parameter name Value Description Additional
businessId string Required
kioskId string Required

Request body

The request body takes a complete BasicKioskEmployeeModel resource, containing the following writable properties:

{
    "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"
}

Properties

Name Type Description
breakStartTimeUtc date-time Nullable
clockOnTimeUtc date-time Nullable
currentShiftId int32 Nullable
employeeGroupIds[] array of int32
employeeId int32 Int32
employeeStartDate date-time Nullable
firstName string String
hasEmail boolean Boolean
longShift boolean Boolean
mobileNumber string String
name string String
profileImageUrl string String
recordedTimeUtc date-time Nullable
status string TimeAttendanceStatus

Possible values are:

  • NotClockedOn
  • ClockedOn
  • OnBreak
  • ClockedOff
surname string String

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK