Update Unavailability

Updates the unavailability with the specified ID.

Request

PUT https://api.yourpayroll.co.uk/api/v2/business/{businessId}/manager/{employeeId}/rostershift/unavailability/{unavailabilityId}

Path parameters

Parameter name Value Description Additional
unavailabilityId int32 Required
businessId string Required
employeeId string Required

Request body

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

{
    "endDate": "date-time",
    "fromDate": "date-time",
    "id": "int32",
    "reason": "string",
    "recurring": "boolean",
    "recurringDay": "string",
    "recurringDays": "string",
    "toDate": "date-time",
    "viewOnly": "boolean"
}

Properties

Name Type Description
endDate date-time Nullable
fromDate date-time DateTime
id int32 Int32
reason string String
recurring boolean Boolean
recurringDay string Nullable

Possible values are:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
recurringDays string Nullable

Possible values are:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
toDate date-time Nullable
viewOnly boolean Boolean

Response

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

Status code Description Resource
200 OK

OK

 ManagerUnavailabilityModel