Skip to main content

CreateResourceAvailabilityInput

No description

input CreateResourceAvailabilityInput {
  comment: String
  unavailability: Boolean!
  unavailabilityType: UnavailabilityType
  user: ID
  room: ID!
  recurrence: AvailabilityRecurrenceInput
  exclusions: [String!]
  startDate: String!
  endDate: String
  startTime: String!
  endTime: String!
}

Fields​

CreateResourceAvailabilityInput.comment ● String scalar​

CreateResourceAvailabilityInput.unavailability ● Boolean! non-null scalar​

CreateResourceAvailabilityInput.unavailabilityType ● UnavailabilityType enum​

Reason for blocked time.

Always send unavailabilityType when unavailability is true, for both ad-hoc and recurring rows. The mutation fails if it is omitted. Omit the field when unavailability is false. The field stays nullable because GraphQL cannot require it only for unavailability.

CreateResourceAvailabilityInput.user ● ID scalar​

CreateResourceAvailabilityInput.room ● ID! non-null scalar​

Room id — PracticeLocation.id.

Do not pass PracticeLocation.groupId (the site / location group). room and groupId are different identifiers; they are not interchangeable with locationIds on availabilitySlots or availabilityRules.

CreateResourceAvailabilityInput.recurrence ● AvailabilityRecurrenceInput input​

Weekly recurrence rule. Omit for a single-day (ad hoc) availability or unavailability.

The same rule creates recurring availability and recurring unavailability. Each occurrence uses startTime and endTime on the selected weekdays. Omit endDate or pass null for an open-ended series.

CreateResourceAvailabilityInput.exclusions ● [String!] list scalar​

List of exclusion dates in YYYY-MM-DD format.

  • Providing an array will add values to the existing exclusions (duplicates ignored).
  • Providing null or omitting the field will creating an empty array.

See Create ad hoc availability for a single day for how to use exclusions with ad hoc availabilities on days that differ from your recurrence rule.

CreateResourceAvailabilityInput.startDate ● String! non-null scalar​

Start date in YYYY-MM-DD format.

CreateResourceAvailabilityInput.endDate ● String scalar​

End date in YYYY-MM-DD format.

For recurring availability or unavailability, sets when the series ends. Can omit or pass null if recurrence has no end date. For ad hoc rows (no recurrence), omit this field or pass null; any other value is rejected, and the stored end date is set to startDate. A date range without recurrence is not continuous leave.

CreateResourceAvailabilityInput.startTime ● String! non-null scalar​

Start time in HH:mm format.

CreateResourceAvailabilityInput.endTime ● String! non-null scalar​

End time in HH:mm format.

Member Of​

createAvailability mutation