POST PlanCare2Api/Appointments/AppointmentCompletions
Completes an appointment. Note: This endpoint is obsolete and will be deleted in a future version of the API.
Deprecated (unavailable from 21.01.1P): Use the endpoint PlanCare2Api/Appointments/AppointmentCompletion instead
Request Information
URI Parameters
None.
Body Parameters
Appointment definition
AppointmentCompletion| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The internal id of the planned appointment. Set to 0 when appointment is part of a recurrence and has no id yet. |
integer |
Required |
| ParentPlannedItemId |
The internal id of the parent appointment when recurring. |
integer |
None |
| OccurrenceIndex |
The index of the occurrence of the appointment when part of a recurrence. |
integer |
None |
| StartDateTime |
The start date and time of the appointment. |
date |
Required |
| Duration |
The duration of the appointment in minutes |
integer |
Required |
| Remarks |
Remarks made to the appointment. |
string |
None |
| Reason |
Reason why the appointment is completed. |
string |
None |
| EmploymentId |
The internal id of the employee's employment who accomplished the appointment. |
integer |
Required |
| WorkTypeId |
The worktype id. |
integer |
None |
| TravelDuration |
Travel duration to client location in minutes. |
integer |
None |
| TravelDistance |
Travel distance in kilometers. |
integer |
None |
| TravelMethodId |
Identity of travel method how an employee reach the client's location. Referenced to 'TravelMethod' (Root data). |
integer |
None |
| Cost |
The Cost |
decimal number |
None |
| CostTypeId |
Identity of cost type. Referenced to 'CostType' (Root data). |
integer |
None |
| ZipCode |
Zip code of client's location. |
string |
None |
| HouseNumber |
House number of client's location. |
integer |
None |
| HouseNumberAddition |
House number addition of client's location. |
string |
None |
| ClientSigned |
Indicates whether client signature is present. |
boolean |
None |
| ProductId |
The product id. |
integer |
Required |
| ProjectId |
The Identifier of the project. Consists of clientmutationId and projectDescription. |
string |
None |
| OrganizationEntityId |
The organization entity id. |
integer |
None |
| ContractId |
The contract id. |
integer |
None |
Request Formats
application/json, text/json
{
"Id": 1,
"ParentPlannedItemId": 1,
"OccurrenceIndex": 1,
"StartDateTime": "2026-05-26T21:12:31.1216862+02:00",
"Duration": 3,
"Remarks": "sample string 4",
"Reason": "sample string 5",
"EmploymentId": 6,
"WorkTypeId": 1,
"TravelDuration": 1,
"TravelDistance": 1,
"TravelMethodId": 1,
"Cost": 1.0,
"CostTypeId": 1,
"ZipCode": "sample string 7",
"HouseNumber": 1,
"HouseNumberAddition": "sample string 8",
"ClientSigned": true,
"ProductId": 9,
"ProjectId": "sample string 10",
"OrganizationEntityId": 1,
"ContractId": 1
}
application/xml, text/xml
<AppointmentCompletion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar"> <ClientSigned>true</ClientSigned> <ContractId>1</ContractId> <Cost>1</Cost> <CostTypeId>1</CostTypeId> <Duration>3</Duration> <EmploymentId>6</EmploymentId> <HouseNumber>1</HouseNumber> <HouseNumberAddition>sample string 8</HouseNumberAddition> <Id>1</Id> <OccurrenceIndex>1</OccurrenceIndex> <OrganizationEntityId>1</OrganizationEntityId> <ParentPlannedItemId>1</ParentPlannedItemId> <ProductId>9</ProductId> <ProjectId>sample string 10</ProjectId> <Reason>sample string 5</Reason> <Remarks>sample string 4</Remarks> <StartDateTime>2026-05-26T21:12:31.1216862+02:00</StartDateTime> <TravelDistance>1</TravelDistance> <TravelDuration>1</TravelDuration> <TravelMethodId>1</TravelMethodId> <WorkTypeId>1</WorkTypeId> <ZipCode>sample string 7</ZipCode> </AppointmentCompletion>
Response Information
Resource Description
AppointmentCompletion
AppointmentCompletion| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The internal id of the planned appointment. Set to 0 when appointment is part of a recurrence and has no id yet. |
integer |
Required |
| ParentPlannedItemId |
The internal id of the parent appointment when recurring. |
integer |
None |
| OccurrenceIndex |
The index of the occurrence of the appointment when part of a recurrence. |
integer |
None |
| StartDateTime |
The start date and time of the appointment. |
date |
Required |
| Duration |
The duration of the appointment in minutes |
integer |
Required |
| Remarks |
Remarks made to the appointment. |
string |
None |
| Reason |
Reason why the appointment is completed. |
string |
None |
| EmploymentId |
The internal id of the employee's employment who accomplished the appointment. |
integer |
Required |
| WorkTypeId |
The worktype id. |
integer |
None |
| TravelDuration |
Travel duration to client location in minutes. |
integer |
None |
| TravelDistance |
Travel distance in kilometers. |
integer |
None |
| TravelMethodId |
Identity of travel method how an employee reach the client's location. Referenced to 'TravelMethod' (Root data). |
integer |
None |
| Cost |
The Cost |
decimal number |
None |
| CostTypeId |
Identity of cost type. Referenced to 'CostType' (Root data). |
integer |
None |
| ZipCode |
Zip code of client's location. |
string |
None |
| HouseNumber |
House number of client's location. |
integer |
None |
| HouseNumberAddition |
House number addition of client's location. |
string |
None |
| ClientSigned |
Indicates whether client signature is present. |
boolean |
None |
| ProductId |
The product id. |
integer |
Required |
| ProjectId |
The Identifier of the project. Consists of clientmutationId and projectDescription. |
string |
None |
| OrganizationEntityId |
The organization entity id. |
integer |
None |
| ContractId |
The contract id. |
integer |
None |
Response Formats
application/json, text/json
{
"Id": 1,
"ParentPlannedItemId": 1,
"OccurrenceIndex": 1,
"StartDateTime": "2026-05-26T21:12:31.137311+02:00",
"Duration": 3,
"Remarks": "sample string 4",
"Reason": "sample string 5",
"EmploymentId": 6,
"WorkTypeId": 1,
"TravelDuration": 1,
"TravelDistance": 1,
"TravelMethodId": 1,
"Cost": 1.0,
"CostTypeId": 1,
"ZipCode": "sample string 7",
"HouseNumber": 1,
"HouseNumberAddition": "sample string 8",
"ClientSigned": true,
"ProductId": 9,
"ProjectId": "sample string 10",
"OrganizationEntityId": 1,
"ContractId": 1
}
application/xml, text/xml
<AppointmentCompletion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar"> <ClientSigned>true</ClientSigned> <ContractId>1</ContractId> <Cost>1</Cost> <CostTypeId>1</CostTypeId> <Duration>3</Duration> <EmploymentId>6</EmploymentId> <HouseNumber>1</HouseNumber> <HouseNumberAddition>sample string 8</HouseNumberAddition> <Id>1</Id> <OccurrenceIndex>1</OccurrenceIndex> <OrganizationEntityId>1</OrganizationEntityId> <ParentPlannedItemId>1</ParentPlannedItemId> <ProductId>9</ProductId> <ProjectId>sample string 10</ProjectId> <Reason>sample string 5</Reason> <Remarks>sample string 4</Remarks> <StartDateTime>2026-05-26T21:12:31.137311+02:00</StartDateTime> <TravelDistance>1</TravelDistance> <TravelDuration>1</TravelDuration> <TravelMethodId>1</TravelMethodId> <WorkTypeId>1</WorkTypeId> <ZipCode>sample string 7</ZipCode> </AppointmentCompletion>