...
Summary
Use this resource to delete surgical pathology report (SPR) for given visit identifier. Use HTTP DELETE method to call this API by passing the below details:
Below are the parameters which need to be sent with the request:
...
Parameter
...
Details
...
Request Details
Use following http DELETE request to delete surgical pathology report (SPR).
http[s]:<host>:<port>/openspecimen/rest/ng/visits/{visitId}/spr-file
Use this URL to delete surgical pathology report (SPR) from OpenSpecimen application.
Result:
Parameter | Details |
|---|---|
| visitId | Identifier of the visit of which you want to delete spr |
Result
The response of this request will delete the surgical pathology report of specified visit identifier.
Below is the example of the delete surgical pathology report (SPR)
is delete status of report. i.e True/False
Example
| URL | http[s]:<host>:<port>/openspecimen/rest/ng/visits/1/spr-file |
| Method | DELETE |
| contentContent-typeType | application/json |
Response | Boolean value true/false |
...
Error Cases :
codeCode | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Surgical Pathology Report (SPR) deleted successfully |
| 401 | All requests | Authorization failed, User doesn't have AuthorityUser does not have sufficient rights to perform this operation |
| 404 | All requests | Visit not found, Visit with given identifier does not exist in the systemspecified in requested operation does not exists |
| 500 | All requests | Internal server error, Encountered server error while performing operationsServer Error. Report this error to system administrator |