Public

Availabilities

Update weekdays availabilities

patch/v1/public/availabilities/weekdays/{availabilityId}

Path parameters

availabilityIdstring required

Request body

fromDatenumber

Effective date from. Format: unix timestamp in milliseconds.

toDatenumber

Effective date to. Format: unix timestamp in milliseconds.

notestring required

Note linked to this availability.

preferredMinHoursPerWeeknumber

Minimum number of hours per week. Max: 168.

preferredMaxHoursPerWeeknumber

Maximum number of hours per week. Max: 168.

preferredMaxHoursPerPayPeriodnumber

Maximum number of hours per pay period. Max: 168.

preferredMaxShiftsPerDaynumber

Maximum number of shifts per day.

preferredMaxShiftsPerWeeknumber

Maximum number of shifts per week.

preferredMaxWeekDaysnumber

Maximum number of weekdays. Max: 5.

preferredMaxWeekendDaysnumber

Maximum number of weekend days. Max: 2.

preferredMaxRestingHoursnumber

Maximum hours between shifts. Max: 168

preferredTeamIdsstring[]

Array of member's preferred team ids.

preferredLocationIdsstring[]

Array of member's preferred location ids.

preferredSkillIdsstring[]

Array of member's preferred skill ids.

allowReplacementsOutsideAvailabilitiesboolean

Allow replacements outside availability.

approverIdstring

Example request

{
  "fromDate": 1788263279853,
  "toDate": 1789472879853,
  "note": "Note for the manager",
  "preferredMinHoursPerWeek": 30,
  "preferredMaxHoursPerWeek": 45,
  "preferredMaxHoursPerPayPeriod": 90,
  "preferredMaxShiftsPerDay": 3,
  "preferredMaxShiftsPerWeek": 3,
  "preferredMaxWeekDays": 5,
  "preferredMaxWeekendDays": 2,
  "preferredMaxRestingHours": 2,
  "preferredTeamIds": [
    "teamId"
  ],
  "preferredLocationIds": [
    "locationId"
  ],
  "preferredSkillIds": [
    "skillId"
  ]
}

Response

Return the updated availability or a new availability if dates has changed.

uidstring required

Availability UID.

allowReplacementsOutsideAvailabilitiesboolean

Allow replacements outside availability.

createdAtnumber required

Availability creation date.

createdByMemberIdstring required

Member uid who created the availability

createdByMemberCodestring required

Member code who created the availability

fromDatenumber

Effective date from. Format: unix timestamp in milliseconds.

groupIdstring required

The group UID linked to this availability.

memberIdstring required

The member UID linked to this availability.

memberCodestring required

The member code linked to this availability.

notestring required

Note linked to this availability.

preferredLocationIdsstring[]

Array of member's preferred location ids.

preferredLocationCodesstring[]

Array of member's preferred location codes.