Mark Shift Notes Read

Marks some shift notes as either read or unread.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes/read-state

Path parameters

Parameter name Value Description Additional
businessId string Required
kioskId string Required
shiftId string Required

Request body

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

{
    "employeeId": "int32",
    "noteIds": [
        "int32"
    ],
    "read": "boolean"
}

Properties

Name Type Description
employeeId int32 Int32
noteIds[] array of int32
read boolean Boolean

Response

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

Status code Description Resource
200 OK

OK