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": "c38e30b4-86c3-440c-9c54-97161741f5aa", "AppointmentId": "5502687c-4f6d-4266-900e-990bd0e4302f", "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>c38e30b4-86c3-440c-9c54-97161741f5aa</AppointmentCancellationRequestId> <AppointmentId>5502687c-4f6d-4266-900e-990bd0e4302f</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": "cf70c96e-bef0-4c4f-90aa-59933bfede7c", "AppointmentId": "81db97df-6057-40bb-bb21-2d0b38116d67", "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>cf70c96e-bef0-4c4f-90aa-59933bfede7c</AppointmentCancellationRequestId> <AppointmentId>81db97df-6057-40bb-bb21-2d0b38116d67</AppointmentId> <CancelReason>sample string 4</CancelReason> <Status>sample string 3</Status> </AppointmentCancellationRequestModel>