Update roster shift

Update an individual roster shift

Request

PUT https://apimy.yourpayroll.io/api/v2/business/{businessId}/manager/rostershift/{rosterShiftId}

Path parameters

Parameter name Value Description Additional
rosterShiftId int32 Required
businessId string Required

Query parameters

Parameter name Value Description Additional
publish boolean Required
clearBreaks boolean Required

Request body

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

{
    "breaks": [
        {
            "endTime": "date-time",
            "id": "int32",
            "isPaidBreak": "boolean",
            "startTime": "date-time"
        }
    ],
    "employeeId": "int32",
    "employeeName": "string",
    "endTime": "date-time",
    "id": "int32",
    "locationId": "int32",
    "locationName": "string",
    "notes": "string",
    "qualifications": [
        {
            "id": "int32",
            "name": "string"
        }
    ],
    "role": {
        "className": "string",
        "hexColourCode": "string",
        "id": "int32",
        "name": "string"
    },
    "startTime": "date-time",
    "workTypeId": "int32",
    "workTypeName": "string"
}

Properties

Name Type Description
breaks[] array
breaks[].endTime date-time DateTime
breaks[].id int32 Int32
breaks[].isPaidBreak boolean Boolean
breaks[].startTime date-time DateTime
employeeId int32 Nullable
employeeName string String
endTime date-time DateTime
id int32 Int32
locationId int32 Nullable
locationName string String
notes string String
qualifications[] array
qualifications[].id int32 Int32
qualifications[].name string String
role object RosterShiftRole
role.className string String
role.hexColourCode string String
role.id int32 Int32
role.name string String
startTime date-time DateTime
workTypeId int32 Nullable
workTypeName string String

Response

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

Status code Description Resource
200 OK

OK