PUT api/appointment/cancel/{id}/Date/{date}
Cancel calculated appointment by id and datetime, if it exists. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
appointment id |
integer |
Required |
| date |
appointment start date |
string |
Required |
Body Parameters
The cancel appointment command data contract supplied with the request.
CancelAppointmentCommandDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| ReasonForCancellation |
The reason for cancellation value. |
string |
None. |
| CancelSeries |
Indicates whether this item can cel series. |
boolean |
None. |
| CancelFutureEvents |
Indicates whether this item can cel future events. |
boolean |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
{
"ReasonForCancellation": "sample string 1",
"CancelSeries": true,
"CancelFutureEvents": true,
"Id": 4
}
Response Information
Resource Description
The response returned after the operation completes.
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version |
The version value. |
Version |
None. |
| Content |
The content value. |
HttpContent |
None. |
| StatusCode |
The status code classification. |
HttpStatusCode |
None. |
| ReasonPhrase |
The reason phrase value. |
string |
None. |
| Headers |
The collection of headers. |
Collection of Object |
None. |
| RequestMessage |
The request message value. |
HttpRequestMessage |
None. |
| IsSuccessStatusCode |
Indicates whether this item is success status code. |
boolean |
None. |