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": "a0778a76-a8a4-4cea-af06-d74619407bfa", "AppointmentId": "b3c155ac-4c6b-445e-ac19-4db8c0badd1e", "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>a0778a76-a8a4-4cea-af06-d74619407bfa</AppointmentCancellationRequestId> <AppointmentId>b3c155ac-4c6b-445e-ac19-4db8c0badd1e</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": "4c0a23c4-6870-4705-9d51-376dcc9c974e", "AppointmentId": "7e920144-6bcd-4f81-8efe-f1ad43dc0246", "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>4c0a23c4-6870-4705-9d51-376dcc9c974e</AppointmentCancellationRequestId> <AppointmentId>7e920144-6bcd-4f81-8efe-f1ad43dc0246</AppointmentId> <CancelReason>sample string 4</CancelReason> <Status>sample string 3</Status> </AppointmentCancellationRequestModel>