Versions Compared

Key

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

Summary

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

...

Parameter
Details
visitIdIdentifier of the visit of which you want to download spr
locked

lock Lock status of surgical pathology report.

1. To lock report value would be 'True'

2. To unlock report value would be 'False'

...

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

{

"locked":true

}

Response

{

"visitId": "1" ,

"visitName": "Visit 1",

"locked":true,

}


Error Cases 

Code
Applies to
Status Message
200All resourcesSurgical Pathology Report (SPR) status updated successfully
401All requestsUser does not have sufficient rights to perform this operation
404All requestsVisit specified in requested operation does not exists
500All requestsInternal Server Error. Report this error to system administrator