Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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-fileUse this URL to delete surgical pathology report (SPR) from OpenSpecimen application

Parameter
Details
visitIdIdentifier 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

URLhttp[s]:<host>:<port>/openspecimen/rest/ng/visits/1/spr-file
MethodDELETE
content-typeapplication/json

Response

Boolean value true/false

...


Error Cases :

codeCode
Applies to
Status Message
200All resourcesSurgical Pathology Report (SPR) deleted successfully
401All requestsAuthorization failed, User doesn't have Authority
404All requestsVisit not found, Visit with given identifier does not exist in the system
500All requestsInternal server error, Encountered server error while performing operations