POST api/patients/{patientId}/prescriptions/{prescriptionId}/updateStatus
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| patientId | integer |
Required |
|
| prescriptionId | integer |
Required |
Body Parameters
UpdatePrescriptionMedicationStatusRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | PatientMedicationStatusType |
Required Range: inclusive between 1 and 5 |
|
| Comment | string |
String length: inclusive between 0 and 500 |
|
| InactiveDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"Status": 0,
"Comment": "sample string 3",
"InactiveDate": "2025-12-14T17:27:09.78857+00:00"
}
application/xml, text/xml
Sample:
<UpdatePrescriptionMedicationStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13"> <Comment>sample string 3</Comment> <InactiveDate>2025-12-14T17:27:09.78857+00:00</InactiveDate> <Status>Unknown</Status> </UpdatePrescriptionMedicationStatusRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Response| Name | Description | Type | Additional 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>