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": "1c0de661-cf52-48d6-98e9-98ca3db3e355",
"AppointmentId": "7c1bd42d-e7f1-48f7-8f05-bb4816a78f31",
"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>1c0de661-cf52-48d6-98e9-98ca3db3e355</AppointmentCancellationRequestId> <AppointmentId>7c1bd42d-e7f1-48f7-8f05-bb4816a78f31</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": "8b411587-b21e-4799-bcfa-51664e2f3299",
"AppointmentId": "d7a1c1cd-d770-4ba9-9ed1-aa60cf39a106",
"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>8b411587-b21e-4799-bcfa-51664e2f3299</AppointmentCancellationRequestId> <AppointmentId>d7a1c1cd-d770-4ba9-9ed1-aa60cf39a106</AppointmentId> <CancelReason>sample string 4</CancelReason> <Status>sample string 3</Status> </AppointmentCancellationRequestModel>