POST PlanCare2Api/Appointments/ReopenAppointment
Reopens an appointment. Appointment without time registration would not be reopened. This functionality is not supported yet. (Status Code: 'NotImplemented')
Request Information
URI Parameters
None.
Body Parameters
Appointment definition
ClosedAppointment| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The internal id of the planned appointment. |
integer |
Required |
| ParentPlannedItemId |
The internal id of the parent appointment when recurring. |
integer |
Nullable Deprecated (unavailable from 21.01.1P): No longer in use. Will be removed in a future version of the API. |
| OccurrenceIndex |
The index of the occurrence of the appointment when part of a recurrence. |
integer |
Nullable Deprecated (unavailable from 21.01.1P): No longer in use. Will be removed in a future version of the API. |
| Reason |
Reason why the the appointment must be reopened. |
string |
- |
Request Formats
application/json, text/json
Sample:
{
"Id": 1,
"ParentPlannedItemId": 1,
"OccurrenceIndex": 1,
"Reason": "sample string 2"
}
application/xml, text/xml
Sample:
<ClosedAppointment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar"> <Id>1</Id> <OccurrenceIndex>1</OccurrenceIndex> <ParentPlannedItemId>1</ParentPlannedItemId> <Reason>sample string 2</Reason> </ClosedAppointment>
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
- |
|
| Content | HttpContent |
- |
|
| StatusCode | HttpStatusCode |
- |
|
| ReasonPhrase | string |
- |
|
| Headers | Collection of Object |
- |
|
| RequestMessage | HttpRequestMessage |
- |
|
| IsSuccessStatusCode | boolean |
- |