GET v1/order/remove?EMRLinkOrderID={EMRLinkOrderID}&permanently={permanently}&reason={reason}
Remove Order: Remove an existing order if it has not been transmitted to the service provider already or the service provider allows for a cancellation message to be sent. If the order has already been transmitted and the service provider does not accept cancellation messages, an error message will be returned.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
EMRLinkOrderID |
EMR-Link generated EMRLinkOrderID. |
string |
Required |
permanently |
Remove order completely. Should only be used for orders entered in error. |
boolean |
Default value is False |
reason |
Reason for removing this order. Only used if permanently is not set to true. |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
BaseResponseName | Description | Type | Additional information |
---|---|---|---|
Error |
Will be set to True if any errors occur during the processing of the API method. |
boolean |
None. |
ErrorMessage |
Will contain an error message string if Error is True. |
string |
None. |
Response Formats
application/json, text/json
{ "Error": true, "ErrorMessage": "sample string 2" }
application/xml, text/xml
<BaseResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Error>true</Error> <ErrorMessage>sample string 2</ErrorMessage> </BaseResponse>