openspecimen/rest/ng/visits/{visitId}/spr-lock
...
Summary
This page contains documentation of lock/unlock surgical pathology report , REST API.
Request Details
Use following http PUT request to lock/unlock surgical pathology report (SPR) of given visit identifier. Use HTTP PUT method to call this API by passing the below details:Below are the parameters which need to be sent with the request:.
http[s]:<host>:<port>/openspecimen/rest/ng/visits/{visitId}/spr-lock
Parameter | Details |
|---|---|
| visitId | Identifier of the visit of which you want to download spr. |
| locked | lock status of surgical pathology report. 1. To lock report value would be 'True' 2. To unlock report value would be 'False' |
...
Use this URL to lock/unlock surgical pathology report (SPR) from OpenSpecimen application.
Result
...
The response of this request contains lock/unlock status of surgical pathology report of specified visit identifier.
Below is the example of the lock/unlock surgical pathology report (SPR)
...
Example
| URL | http[s]:<host>:<port>/openspecimen/rest/ng/visits/1/spr-lock |
| Method | PUT |
| content-type | application/json |
| Request | { "locked":true } |
Response | { "visitId": "1" , "visitName": "Visit 1", "locked":true, } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Surgical Pathology Report (SPR) status updated successfully |
| 401 | All requests | Authorization failed, User doesn't have Authority |
| 404 | All requests | Visit not found, Visit with given identifier does not exist in the system |
| 500 | All requests | Internal server error, Encountered server error while performing operations |