CLclinicos
ScheduleItems

Update a single instance of a recurring schedule item. Creates an exception record that overrides the specific occurrence.

Changed on
put/ScheduleItems/{id}/instance

Request

Path parameters

idstring required

Request body

originalStartTimestring date-time required
titlestring nullable
startTimestring date-time nullable
endTimestring date-time nullable
descriptionstring nullable
locationIdstring nullable
assignedToIdstring nullable
isCancelledboolean

Response

OK

idstring
titlestring
startTimestring date-time
endTimestring date-time
descriptionstring nullable
typestring
locationIdstring
assignedToIdstring nullable
customAttributesstring nullable
createdAtstring date-time
updatedAtstring date-time
createdByIdstring nullable
createdBySourcestring nullable
hasAppointmentboolean
isRecurringboolean
recurrenceRulestring nullable
recurrenceEndDatestring date-time nullable
isExceptionboolean
parentScheduleItemIdstring nullable
isRecurrenceInstanceboolean
originalStartTimestring date-time nullable

Example response

{
  "appointment": {
    "patient": {
      "species": "Cat",
      "breed": "Siamese",
      "sex": "Male"
    }
  }
}

Changes

  • 021fabd866ffRevision changes
    • info

      added the optional property ///// to the response with the status (media type: text/plain)

    • info

      added the optional property ///// to the response with the status (media type: application/json)

    • info

      added the optional property ///// to the response with the status (media type: text/json)

  • 503cd0546309Revision changes
    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)