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.
AppointmentCancellationRequestModelName | 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": "e00613c0-3c31-47e3-a466-19a162d6c8ef", "AppointmentId": "6c13cb03-15da-4033-aec3-48e8318b8978", "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>e00613c0-3c31-47e3-a466-19a162d6c8ef</AppointmentCancellationRequestId> <AppointmentId>6c13cb03-15da-4033-aec3-48e8318b8978</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
AppointmentCancellationRequestModelName | 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": "d5eac4d5-b9ac-418c-ae5d-aa3812d90b49", "AppointmentId": "a7b7255a-9120-4434-9cbe-bdfe97739214", "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>d5eac4d5-b9ac-418c-ae5d-aa3812d90b49</AppointmentCancellationRequestId> <AppointmentId>a7b7255a-9120-4434-9cbe-bdfe97739214</AppointmentId> <CancelReason>sample string 4</CancelReason> <Status>sample string 3</Status> </AppointmentCancellationRequestModel>