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": "2b3b94b3-3d2b-4f01-b174-c98b8b68e68d", "AppointmentId": "42c4e5ec-a8f8-4733-8f18-8fb101076871", "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>2b3b94b3-3d2b-4f01-b174-c98b8b68e68d</AppointmentCancellationRequestId> <AppointmentId>42c4e5ec-a8f8-4733-8f18-8fb101076871</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": "506adb86-5369-444e-9ba0-4b7aaf8cdaae", "AppointmentId": "50c7b9e4-3431-4993-af61-26a6e189128b", "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>506adb86-5369-444e-9ba0-4b7aaf8cdaae</AppointmentCancellationRequestId> <AppointmentId>50c7b9e4-3431-4993-af61-26a6e189128b</AppointmentId> <CancelReason>sample string 4</CancelReason> <Status>sample string 3</Status> </AppointmentCancellationRequestModel>