Updates the kiosk with the specified ID.

Request

PUT https://api.yourpayroll.com.au/api/v2/business/{businessId}/kiosk/{id}

Path parameters

Parameter name Value Description Additional
id int32 Required
businessId string Required

Request body

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

{
    "allowEmployeeShiftSelection": "boolean",
    "allowHigherClassificationSelection": "boolean",
    "branding": {
        "backgroundColour": "string",
        "backgroundImageUrl": "string",
        "logoUrl": "string",
        "textColour": "string",
        "textHoverColour": "string",
        "textSecondaryColour": "string"
    },
    "clockOffWindowMinutes": "int32",
    "clockOnWindowMinutes": "int32",
    "externalId": "string",
    "id": "int32",
    "isLocationRequired": "boolean",
    "isPhotoRequired": "boolean",
    "isWorkTypeRequired": "boolean",
    "locationId": "int32",
    "name": "string",
    "restrictLocationsForEmployees": "boolean",
    "timeZone": "string"
}

Properties

Name Type
allowEmployeeShiftSelection boolean
allowHigherClassificationSelection boolean
branding object
branding.backgroundColour string
branding.backgroundImageUrl string
branding.logoUrl string
branding.textColour string
branding.textHoverColour string
branding.textSecondaryColour string
clockOffWindowMinutes int32
clockOnWindowMinutes int32
externalId string
id int32
isLocationRequired boolean
isPhotoRequired boolean
isWorkTypeRequired boolean
locationId int32
name string
restrictLocationsForEmployees boolean
timeZone string

Response

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

Status code Description Resource
200 OK

OK