GET PlanCare2Api/Appointments/Employee?dateFrom={dateFrom}&dateUntil={dateUntil}

Gets all appointments for the logged on employee that occur in the specified period

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

Request Information

URI Parameters

Name	Description	Type	Additional information
dateFrom	Startdate (+ 00:00) of period	date	Required
dateUntil	Enddate (+ 23:59) of period	date	Required

Body Parameters

None.

Response Information

Resource Description

List of appointments

Collection of Appointment

Name	Description	Type	Additional information
ClientId	The internal id of the client.	integer	None
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
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
StartDate	The start date of the appointment.	date	None
EndDate	The end date of the appointment.	date	None
Subject	The subject of the appointment.	string	None
AppointmentType	The type of the appointment.	string	None
Reason	The given reason when the appointment is completed or cancelled.	string	None
Remarks	Remarks made to the appointment.	string	None
Status	The status of the appointment.	string	None
ParentPlannedItemId	The internal id of the parent appointment.	integer	None
OccurrenceIndex	The index of the occurrence of the appointment when part of an recurrence.	integer	None
Id	The internal id of the planned appointment.	integer	None
StartTime	The start time of the appointment.	date	Deprecated (unavailable from 21.01.1P): Please use 'StartDate' instead.
EndTime	The end time of the appointment.	date	Deprecated (unavailable from 21.01.1P): Please use 'EndDate' instead.
Location	The location of the appointment.	string	None
MovesToNextDay	Determines whether the appointment will be moved to the next day when not completed.	boolean	None
IsAllDay	Is the appointment created as an all-day appointment.	boolean	None
RecursionText	Description of the recurrence of the appointment. Empty when the appointment is not recurring.	string	None
Actions	List of related actions.	Collection of Action	None
WorkTypeId	The id of the worktype.	integer	None
EmploymentId	The internal id of the employee's employment.	integer	None
WeekPlanningId	The Id of the WeekPlanning.	integer	None

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "ClientId": 1,
    "ClientName": "sample string 2",
    "EmployeeId": 1,
    "EmployeeName": "sample string 3",
    "StatusChangedByName": "sample string 4",
    "StatusChangedById": 5,
    "CreatedByName": "sample string 6",
    "CreatedById": 7,
    "StartDate": "2026-05-26T21:05:44.0019591+02:00",
    "EndDate": "2026-05-26T21:05:44.0019591+02:00",
    "Subject": "sample string 10",
    "AppointmentType": "sample string 11",
    "Reason": "sample string 12",
    "Remarks": "sample string 13",
    "Status": "sample string 14",
    "ParentPlannedItemId": 1,
    "OccurrenceIndex": 1,
    "Id": 15,
    "StartTime": "2026-05-26T21:05:44.0019591+02:00",
    "EndTime": "2026-05-26T21:05:44.0019591+02:00",
    "Location": "sample string 18",
    "MovesToNextDay": true,
    "IsAllDay": true,
    "RecursionText": "sample string 21",
    "Actions": [
      {
        "$id": "2",
        "Id": 1,
        "Name": "sample string 2",
        "IsLegacy": true
      },
      {
        "$ref": "2"
      }
    ],
    "WorkTypeId": 1,
    "EmploymentId": 1,
    "WeekPlanningId": 1
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAppointment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">
  <Appointment>
    <Actions xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
      <d3p1:Action>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsLegacy>true</d3p1:IsLegacy>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Action>
      <d3p1:Action>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsLegacy>true</d3p1:IsLegacy>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Action>
    </Actions>
    <AppointmentType>sample string 11</AppointmentType>
    <ClientId>1</ClientId>
    <ClientName>sample string 2</ClientName>
    <CreatedById>7</CreatedById>
    <CreatedByName>sample string 6</CreatedByName>
    <EmployeeId>1</EmployeeId>
    <EmployeeName>sample string 3</EmployeeName>
    <EmploymentId>1</EmploymentId>
    <EndDate>2026-05-26T21:05:44.0019591+02:00</EndDate>
    <EndTime>2026-05-26T21:05:44.0019591+02:00</EndTime>
    <Id>15</Id>
    <IsAllDay>true</IsAllDay>
    <Location>sample string 18</Location>
    <MovesToNextDay>true</MovesToNextDay>
    <OccurrenceIndex>1</OccurrenceIndex>
    <ParentPlannedItemId>1</ParentPlannedItemId>
    <Reason>sample string 12</Reason>
    <RecursionText>sample string 21</RecursionText>
    <Remarks>sample string 13</Remarks>
    <StartDate>2026-05-26T21:05:44.0019591+02:00</StartDate>
    <StartTime>2026-05-26T21:05:44.0019591+02:00</StartTime>
    <Status>sample string 14</Status>
    <StatusChangedById>5</StatusChangedById>
    <StatusChangedByName>sample string 4</StatusChangedByName>
    <Subject>sample string 10</Subject>
    <WeekPlanningId>1</WeekPlanningId>
    <WorkTypeId>1</WorkTypeId>
  </Appointment>
  <Appointment>
    <Actions xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
      <d3p1:Action>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsLegacy>true</d3p1:IsLegacy>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Action>
      <d3p1:Action>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsLegacy>true</d3p1:IsLegacy>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:Action>
    </Actions>
    <AppointmentType>sample string 11</AppointmentType>
    <ClientId>1</ClientId>
    <ClientName>sample string 2</ClientName>
    <CreatedById>7</CreatedById>
    <CreatedByName>sample string 6</CreatedByName>
    <EmployeeId>1</EmployeeId>
    <EmployeeName>sample string 3</EmployeeName>
    <EmploymentId>1</EmploymentId>
    <EndDate>2026-05-26T21:05:44.0019591+02:00</EndDate>
    <EndTime>2026-05-26T21:05:44.0019591+02:00</EndTime>
    <Id>15</Id>
    <IsAllDay>true</IsAllDay>
    <Location>sample string 18</Location>
    <MovesToNextDay>true</MovesToNextDay>
    <OccurrenceIndex>1</OccurrenceIndex>
    <ParentPlannedItemId>1</ParentPlannedItemId>
    <Reason>sample string 12</Reason>
    <RecursionText>sample string 21</RecursionText>
    <Remarks>sample string 13</Remarks>
    <StartDate>2026-05-26T21:05:44.0019591+02:00</StartDate>
    <StartTime>2026-05-26T21:05:44.0019591+02:00</StartTime>
    <Status>sample string 14</Status>
    <StatusChangedById>5</StatusChangedById>
    <StatusChangedByName>sample string 4</StatusChangedByName>
    <Subject>sample string 10</Subject>
    <WeekPlanningId>1</WeekPlanningId>
    <WorkTypeId>1</WorkTypeId>
  </Appointment>
</ArrayOfAppointment>