POST api/AppointmentCancelRequests

Sets the status for the appointment cancellation request to approved or denied. (To do) Triggers an email to inform patient of the results of the cancellation request.

Request Information

URI Parameters

None.

Body Parameters

AppointmentRequestResultModel
NameDescriptionTypeAdditional information
InternalID

Request's unique ID.

globally unique identifier

None.

Approved

Result of request whether approved or denied.

boolean

None.

ResultMessage

Result message.

string

None.

ErrorMessage

Error message.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "internalID": "17e54974-2d9d-4175-a624-439ed68642ea",
  "approved": true,
  "resultMessage": "sample string 3",
  "errorMessage": "sample string 4"
}

application/xml, text/xml

Sample:
<AppointmentRequestResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.AppointmentRequestResults">
  <Approved>true</Approved>
  <ErrorMessage>sample string 4</ErrorMessage>
  <InternalID>17e54974-2d9d-4175-a624-439ed68642ea</InternalID>
  <ResultMessage>sample string 3</ResultMessage>
</AppointmentRequestResultModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AppointmentRequestResultModel'.

Response Information

Resource Description

AppointmentRequestResultModel
NameDescriptionTypeAdditional information
InternalID

Request's unique ID.

globally unique identifier

None.

Approved

Result of request whether approved or denied.

boolean

None.

ResultMessage

Result message.

string

None.

ErrorMessage

Error message.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "internalID": "7a97704b-ecf0-450a-b231-852c46206bf5",
  "approved": true,
  "resultMessage": "sample string 3",
  "errorMessage": "sample string 4"
}

application/xml, text/xml

Sample:
<AppointmentRequestResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.AppointmentRequestResults">
  <Approved>true</Approved>
  <ErrorMessage>sample string 4</ErrorMessage>
  <InternalID>7a97704b-ecf0-450a-b231-852c46206bf5</InternalID>
  <ResultMessage>sample string 3</ResultMessage>
</AppointmentRequestResultModel>