POST api/AppointmentCancellationRequest
Adds a request to cancel an appointment.
Request Information
URI Parameters
None.
Body Parameters
Model used to request to cancel an appointment.
AppointmentCancellationRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| AppointmentCancellationRequestId |
Unique ID of appointment cancellation request (Read only). |
globally unique identifier |
None. |
| AppointmentId |
Unique ID of the appointment to be canceled (Required). |
globally unique identifier |
None. |
| Status |
Status of the appointment cancellation request (Read only). |
string |
None. |
| CancelReason |
Reason to cancel the appointment request. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"AppointmentCancellationRequestId": "9a71b3e3-ff30-43bd-bfe7-02d5056b79d3",
"AppointmentId": "ba71c4e0-8b86-427d-a312-b066ed47ffcc",
"Status": "sample string 3",
"CancelReason": "sample string 4"
}
application/xml, text/xml
Sample:
<AppointmentCancellationRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.AppointmentCancelRequests"> <AppointmentCancellationRequestId>9a71b3e3-ff30-43bd-bfe7-02d5056b79d3</AppointmentCancellationRequestId> <AppointmentId>ba71c4e0-8b86-427d-a312-b066ed47ffcc</AppointmentId> <CancelReason>sample string 4</CancelReason> <Status>sample string 3</Status> </AppointmentCancellationRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AppointmentCancellationRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| AppointmentCancellationRequestId |
Unique ID of appointment cancellation request (Read only). |
globally unique identifier |
None. |
| AppointmentId |
Unique ID of the appointment to be canceled (Required). |
globally unique identifier |
None. |
| Status |
Status of the appointment cancellation request (Read only). |
string |
None. |
| CancelReason |
Reason to cancel the appointment request. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"AppointmentCancellationRequestId": "ad708a05-b4df-4858-a9fc-3b8d9743dd7e",
"AppointmentId": "6b74849d-c740-42d8-a3a9-785df9a14ca1",
"Status": "sample string 3",
"CancelReason": "sample string 4"
}
application/xml, text/xml
Sample:
<AppointmentCancellationRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.AppointmentCancelRequests"> <AppointmentCancellationRequestId>ad708a05-b4df-4858-a9fc-3b8d9743dd7e</AppointmentCancellationRequestId> <AppointmentId>6b74849d-c740-42d8-a3a9-785df9a14ca1</AppointmentId> <CancelReason>sample string 4</CancelReason> <Status>sample string 3</Status> </AppointmentCancellationRequestModel>