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": "7f641d6a-cc93-455a-b5ac-c048905f1308", "AppointmentId": "2f6945af-cfa1-49f4-9508-0bafee16f9a4", "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>7f641d6a-cc93-455a-b5ac-c048905f1308</AppointmentCancellationRequestId> <AppointmentId>2f6945af-cfa1-49f4-9508-0bafee16f9a4</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": "8ad49b95-f631-41c2-88f1-35a47308d41c", "AppointmentId": "d5a7e7d2-4611-4ade-b944-19f921d8607e", "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>8ad49b95-f631-41c2-88f1-35a47308d41c</AppointmentCancellationRequestId> <AppointmentId>d5a7e7d2-4611-4ade-b944-19f921d8607e</AppointmentId> <CancelReason>sample string 4</CancelReason> <Status>sample string 3</Status> </AppointmentCancellationRequestModel>