POST api/appointments/{Id}/cancel

Request Information

URI Parameters

Name	Description	Type	Additional information
Id		string	Required

Body Parameters

AppointmentCancellationInputModel

Name	Description	Type	Additional information
Reason		string	None.

Request Formats

application/json, text/json

Sample:

{
  "Reason": "sample string 1"
}

application/xml, text/xml

Sample:

<AppointmentCancellationInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.Property.API.Models">
  <Reason>sample string 1</Reason>
</AppointmentCancellationInputModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BookingQueueCancellationOutputModel

Name	Type	Additional information
Id	string	None.
BookingType	string	None.
BookingId	string	None.
CancellationReason	string	None.
RefundStatus	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "BookingType": "sample string 2",
  "BookingId": "sample string 3",
  "CancellationReason": "sample string 4",
  "RefundStatus": "sample string 5"
}

application/xml, text/xml

Sample:

<BookingQueueCancellationOutputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.Property.API.Models">
  <BookingId>sample string 3</BookingId>
  <BookingType>sample string 2</BookingType>
  <CancellationReason>sample string 4</CancellationReason>
  <Id>sample string 1</Id>
  <RefundStatus>sample string 5</RefundStatus>
</BookingQueueCancellationOutputModel>