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: Please use 'StartDate' instead. |
| EndTime |
The end time of the appointment. |
date |
Deprecated: 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 |
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.