POST PlanCare2Api/Appointments/AppointmentCompletion

Completes an appointment.

Request Information

URI Parameters

None.

Body Parameters

Appointment definition

AppointmentCompletion
NameDescriptionTypeAdditional 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

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Er is een uitzondering opgetreden van het type System.OutOfMemoryException.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Er is een uitzondering opgetreden van het type System.OutOfMemoryException.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Er is een uitzondering opgetreden van het type System.OutOfMemoryException.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Er is een uitzondering opgetreden van het type System.OutOfMemoryException.

Response Information

Resource Description

AppointmentCompletion

AppointmentCompletion
NameDescriptionTypeAdditional 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

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Er is een uitzondering opgetreden van het type System.OutOfMemoryException.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Er is een uitzondering opgetreden van het type System.OutOfMemoryException.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Er is een uitzondering opgetreden van het type System.OutOfMemoryException.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Er is een uitzondering opgetreden van het type System.OutOfMemoryException.