POST api/patients/{patientId}/prescriptions/{prescriptionId}/cancel

Request Information

URI Parameters

NameDescriptionTypeAdditional information
patientId

integer

Required

prescriptionId

integer

Required

Body Parameters

CancelPrescriptionRequest
NameDescriptionTypeAdditional information
Comment

string

String length: inclusive between 0 and 500

Request Formats

application/json, text/json

Sample:
{
  "Comment": "sample string 1"
}

application/xml, text/xml

Sample:
<CancelPrescriptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <Comment>sample string 1</Comment>
</CancelPrescriptionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Response
NameDescriptionTypeAdditional information
Result

Result

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "ResultCode": "sample string 1",
    "ResultDescription": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <Result>
    <ResultCode>sample string 1</ResultCode>
    <ResultDescription>sample string 2</ResultDescription>
  </Result>
</Response>