openspecimen/rest/ng/visits/{visitId}/spr-text
Use this resource to get surgical pathology report's text content for given visit identifier. Use HTTP GET method to call this API by passing the below details:
Below are the parameters which need to be sent with the request:
Parameter | Details |
|---|---|
| visitId | Identifier of the visit of which you want spr text. |
http[s]:<host>:<port>/openspecimen/rest/ng/visits/{visitId}/spr-text
Use this URL to get surgical pathology report's (SPR) text from OpenSpecimen application.
Result:
The response of this request will return the text of surgical pathology report of specified visit identifier.
Below is the example to get surgical pathology report (SPR) text.
| URL | http[s]:<host>:<port>/openspecimen/rest/ng/visits/1/spr-text |
| Method | GET |
| content-type | application/json |
Response | surgical pathology report text |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Surgical pathology report text retrieved 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 |