GET PlanCare2Api/ClientAppointments/ActionAppointments/{appointmentId}?occurrenceRangeFrom={occurrenceRangeFrom}&occurrenceRangeUntil={occurrenceRangeUntil}

Obtains the action appointment

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

Request Information

URI Parameters

Name	Description	Type	Additional information
appointmentId	The identifier of the action appointment.	integer	Required
occurrenceRangeFrom	The start of the range which is used to fetch the occurrences of a recurring appointment. When null, no occurrences are returned. Will be ignored for normal appointments	date	Required
occurrenceRangeUntil	The end of the range which is used to fetch the occurrences of a recurring appointment. When null, no occurrences are returned. Will be ignored for normal appointments.	date	Required

Body Parameters

None.

Response Information

Resource Description

The action appointment.

ActionAppointment

Name	Description	Type	Additional information
ActionIds	The collection of Action ids	Collection of integer	Required
ClientId	The internal id of the client.	integer	Required
ClientName	The name of the client.	string	None
EmployeeId	The internal id of the employee who owns the appointment.	integer	None
EmployeeName	The name of the employee who owns the appointment.	string	None
EmploymentId	The internal id of the employment of the specified employee.	integer	None
ContractOfServiceId	The internal id of the employment of the specified employee.	integer	Deprecated: Please use 'EmploymentId' instead.
Start	The start date and time of the appointment.	date	Required
End	The end date and time of the appointment.	date	Required
Title	The subject of the appointment.	string	Required
Reason	The given reason when the appointment is completed or cancelled.	string	None
Status	Defines the status of the appointment. A Recurrence appointment will always have the status 'Created'.	PlannedItemStatus	None
StatusChangedByName	The name of the employee who changed the status of the appointment.	string	None
StatusChangedById	The id of the employee who changed the status of the appointment.	integer	None
CreatedByName	The name of the employee who created the appointment.	string	None
CreatedById	The id of the employee who created the appointment.	integer	None
Remarks	Remarks made to the appointment.	string	None
Id	The internal id of the appointment.	integer	Conditional Required: Only required for existing appointments
Location	The location of the appointment.	string	None
MovesToNextDay	Determines whether the appointment will be moved to the next day when not completed.	boolean	Required
IsAllDay	Is the appointment created as an all-day appointment.	boolean	Required
FriendlyRecurrenceInfo	The user friendly description of the recurrence for the appointment. This description is readonly. Only set when type is Recurrence.	string	None
RecurrenceInfo	Defines the recurrence for the appointment. Only set when type is Recurrence. When creating a appointment the RecurrenceStart property of RecurrenceInfo must be equal to the Start property. Can be left empty if you want to remove the recurrence.	RecurrenceInfo	None
RecurrenceOccurrences	The list of occurrences if the appointment is recurrent. Only occurrences within the provided range are returned Only set when type is Recurrence	Collection of OccurrenceAppointment	None
Type	Defines the type of the appointment, default type is normal	AppointmentType	None
ShiftId	The Id of the Shift	integer	None
ContractInfo	The appointment ContractInfo	string	None

Response Formats

application/json, text/json

Sample:

{
  "ActionIds": [
    1,
    2
  ],
  "ClientId": 1,
  "ClientName": "sample string 2",
  "EmployeeId": 1,
  "EmployeeName": "sample string 3",
  "EmploymentId": 1,
  "ContractOfServiceId": 1,
  "Start": "2026-05-26T23:13:10.6656611+02:00",
  "End": "2026-05-26T23:13:10.6656611+02:00",
  "Title": "sample string 6",
  "Reason": "sample string 7",
  "Status": 0,
  "StatusChangedByName": "sample string 8",
  "StatusChangedById": 9,
  "CreatedByName": "sample string 10",
  "CreatedById": 11,
  "Remarks": "sample string 12",
  "Id": 13,
  "Location": "sample string 14",
  "MovesToNextDay": true,
  "IsAllDay": true,
  "FriendlyRecurrenceInfo": "sample string 17",
  "RecurrenceInfo": {
    "$id": "2",
    "OccurrenceCount": 1,
    "Periodicity": 1,
    "Range": 0,
    "Interval": 0,
    "WeekDays": 1,
    "RecurrenceStart": "2026-05-26T23:13:10.6656611+02:00",
    "RecurrenceEnd": "2026-05-26T23:13:10.6656611+02:00",
    "Month": 1,
    "DayNumber": 1,
    "WeekOfMonth": 0
  },
  "RecurrenceOccurrences": [
    {
      "$id": "3",
      "Id": 1,
      "Start": "2026-05-26T23:13:10.6656611+02:00",
      "End": "2026-05-26T23:13:10.6656611+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"
    },
    {
      "$ref": "3"
    }
  ],
  "Type": 0,
  "ShiftId": 1,
  "ContractInfo": "sample string 18"
}

application/xml, text/xml

Sample:

<ActionAppointment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar.Client">
  <ContractInfo xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 18</ContractInfo>
  <CreatedById xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">11</CreatedById>
  <CreatedByName xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 10</CreatedByName>
  <End xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">2026-05-26T23:13:10.6656611+02:00</End>
  <FriendlyRecurrenceInfo xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 17</FriendlyRecurrenceInfo>
  <Id xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">13</Id>
  <IsAllDay xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">true</IsAllDay>
  <Location xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 14</Location>
  <MovesToNextDay xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">true</MovesToNextDay>
  <Reason xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 7</Reason>
  <RecurrenceInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar.Recurrence" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">
    <d2p1:DayNumber>1</d2p1:DayNumber>
    <d2p1:Interval>Daily</d2p1:Interval>
    <d2p1:Month>1</d2p1:Month>
    <d2p1:OccurrenceCount>1</d2p1:OccurrenceCount>
    <d2p1:Periodicity>1</d2p1:Periodicity>
    <d2p1:Range>NoEndDate</d2p1:Range>
    <d2p1:RecurrenceEnd>2026-05-26T23:13:10.6656611+02:00</d2p1:RecurrenceEnd>
    <d2p1:RecurrenceStart>2026-05-26T23:13:10.6656611+02:00</d2p1:RecurrenceStart>
    <d2p1:WeekDays>Sunday</d2p1:WeekDays>
    <d2p1:WeekOfMonth>None</d2p1:WeekOfMonth>
  </RecurrenceInfo>
  <RecurrenceOccurrences xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">
    <OccurrenceAppointment>
      <CreatedById>12</CreatedById>
      <CreatedByName>sample string 11</CreatedByName>
      <End>2026-05-26T23:13:10.6656611+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-26T23:13:10.6656611+02:00</Start>
      <Status>Created</Status>
      <StatusChangedById>10</StatusChangedById>
      <StatusChangedByName>sample string 9</StatusChangedByName>
      <Title>sample string 4</Title>
      <Type>Occurrence</Type>
    </OccurrenceAppointment>
    <OccurrenceAppointment>
      <CreatedById>12</CreatedById>
      <CreatedByName>sample string 11</CreatedByName>
      <End>2026-05-26T23:13:10.6656611+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-26T23:13:10.6656611+02:00</Start>
      <Status>Created</Status>
      <StatusChangedById>10</StatusChangedById>
      <StatusChangedByName>sample string 9</StatusChangedByName>
      <Title>sample string 4</Title>
      <Type>Occurrence</Type>
    </OccurrenceAppointment>
  </RecurrenceOccurrences>
  <Remarks xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 12</Remarks>
  <ShiftId xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">1</ShiftId>
  <Start xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">2026-05-26T23:13:10.6656611+02:00</Start>
  <Status xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">Created</Status>
  <StatusChangedById xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">9</StatusChangedById>
  <StatusChangedByName xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 8</StatusChangedByName>
  <Title xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 6</Title>
  <Type xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">Normal</Type>
  <ClientId>1</ClientId>
  <ClientName>sample string 2</ClientName>
  <ContractOfServiceId>1</ContractOfServiceId>
  <EmployeeId>1</EmployeeId>
  <EmployeeName>sample string 3</EmployeeName>
  <EmploymentId>1</EmploymentId>
  <ActionIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </ActionIds>
</ActionAppointment>