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": "bf4175b2-1f7d-4c15-96e7-2672cf02b254",
"AppointmentId": "5a2a7115-f3bc-4b5d-9957-194ef75051d0",
"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>bf4175b2-1f7d-4c15-96e7-2672cf02b254</AppointmentCancellationRequestId> <AppointmentId>5a2a7115-f3bc-4b5d-9957-194ef75051d0</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": "5408b668-f431-45c0-ba4e-7b5ec89ba84e",
"AppointmentId": "58cbc1fc-23b7-43ac-bdd6-89191155c123",
"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>5408b668-f431-45c0-ba4e-7b5ec89ba84e</AppointmentCancellationRequestId> <AppointmentId>58cbc1fc-23b7-43ac-bdd6-89191155c123</AppointmentId> <CancelReason>sample string 4</CancelReason> <Status>sample string 3</Status> </AppointmentCancellationRequestModel>