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.

AppointmentCancellationRequestModel
NameDescriptionTypeAdditional 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": "617102c4-f92f-41b5-9cd9-c468c3981348",
  "AppointmentId": "1deab441-1447-4552-b96f-6a3e4b3925e5",
  "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>617102c4-f92f-41b5-9cd9-c468c3981348</AppointmentCancellationRequestId>
  <AppointmentId>1deab441-1447-4552-b96f-6a3e4b3925e5</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

AppointmentCancellationRequestModel
NameDescriptionTypeAdditional 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": "30d54481-d1cc-4a8a-9c77-707085955575",
  "AppointmentId": "95747f29-65ce-41d6-b40a-31d015d1735f",
  "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>30d54481-d1cc-4a8a-9c77-707085955575</AppointmentCancellationRequestId>
  <AppointmentId>95747f29-65ce-41d6-b40a-31d015d1735f</AppointmentId>
  <CancelReason>sample string 4</CancelReason>
  <Status>sample string 3</Status>
</AppointmentCancellationRequestModel>