This page contains documentation of lock/unlock surgical pathology report , REST API.

Use following http PUT request to lock/unlock surgical pathology report (SPR).

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'

The response of this request contains lock/unlock status of surgical pathology report of specified visit identifier.

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	User does not have sufficient rights to perform this operation
404	All requests	Visit specified in requested operation does not exists
500	All requests	Internal Server Error. Report this error to system administrator

Browser not supported