POST PlanCare2Api/ClientAppointments/ChangeOfOccurrenceAppointments

Updates an existing OccurrenceAppointment instance. This appointment is part of a recurring Appointment

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

Request Information

URI Parameters

None.

Body Parameters

The OccurrenceAppointment instance

ChangeOfOccurrenceAppointment
Name Description Type Additional information
Id

The Id of the occurrence.

integer

Required

Start

The start date and time of the occurrence.

date

Required

End

The end date and time of the occurrence.

date

Required

Title

The subject of the appointment.

string

Required

Location

The location of the appointment.

string

-

ParentId

The Id of the parent appointment.

integer

Required

OccurrenceIndex

The index of the occurrence.

integer

Required

Type

Defines the type of the occurrence.

OccurrenceType

Required

Reason

The given reason when the appointment is completed or cancelled. This property is for reading purposes only.

string

-

Status

Defines the status of the appointment. This property is for reading purposes only.

PlannedItemStatus

-

StatusChangedByName

The name of the employee who changed the status of the appointment.

string

-

StatusChangedById

The id of the employee who changed the status of the appointment.

integer

-

CreatedByName

The name of the employee who created the appointment.

string

-

CreatedById

The id of the employee who created the appointment.

integer

-

Remarks

The remarks for the occurrence.

string

-

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Start": "2026-05-26T22:07:02.5206775+02:00",
  "End": "2026-05-26T22:07:02.5206775+02:00",
  "Title": "sample string 4",
  "Location": "sample string 5",
  "ParentId": 6,
  "OccurrenceIndex": 7,
  "Type": 0,
  "Reason": "sample string 8",
  "Status": 0,
  "StatusChangedByName": "sample string 9",
  "StatusChangedById": 10,
  "CreatedByName": "sample string 11",
  "CreatedById": 12,
  "Remarks": "sample string 13"
}

application/xml, text/xml

Sample:
<ChangeOfOccurrenceAppointment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">
  <CreatedById>12</CreatedById>
  <CreatedByName>sample string 11</CreatedByName>
  <End>2026-05-26T22:07:02.5206775+02:00</End>
  <Id>1</Id>
  <Location>sample string 5</Location>
  <OccurrenceIndex>7</OccurrenceIndex>
  <ParentId>6</ParentId>
  <Reason>sample string 8</Reason>
  <Remarks>sample string 13</Remarks>
  <Start>2026-05-26T22:07:02.5206775+02:00</Start>
  <Status>Created</Status>
  <StatusChangedById>10</StatusChangedById>
  <StatusChangedByName>sample string 9</StatusChangedByName>
  <Title>sample string 4</Title>
  <Type>Occurrence</Type>
</ChangeOfOccurrenceAppointment>

Response Information

Resource Description

Returns the HttpResponseMessage which contains the saved OccurrenceAppointment instance

HttpResponseMessage
Name Description Type Additional information
Version

Version

-

Content

HttpContent

-

StatusCode

HttpStatusCode

-

ReasonPhrase

string

-

Headers

Collection of Object

-

RequestMessage

HttpRequestMessage

-

IsSuccessStatusCode

boolean

-