Creates a new kiosk for the business.

Request

POST http://keypay.yourpayroll.local/api/v2/business/{businessId}/kiosk

Path parameters

Parameter name Value Description Additional
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 Description
allowEmployeeShiftSelection boolean Nullable
allowHigherClassificationSelection boolean Boolean
branding object WhiteLabelBrandingModel
branding.backgroundColour string String
branding.backgroundImageUrl string String
branding.logoUrl string String
branding.textColour string String
branding.textHoverColour string String
branding.textSecondaryColour string String
clockOffWindowMinutes int32 Nullable
clockOnWindowMinutes int32 Nullable
externalId string String
id int32 Int32
isLocationRequired boolean Boolean
isPhotoRequired boolean Nullable
isWorkTypeRequired boolean Boolean
locationId int32 Nullable
name string String
restrictLocationsForEmployees boolean Boolean
timeZone string String

Response

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

Status code Description Resource
200 OK

OK