Summary
This page contains documentation of REST API to get surgical pathology report text.
Request Details
Use following http GET request to get surgical pathology report (SPR) text.
http[s]:<host>:<port>/openspecimen/rest/ng/visits/{visitId}/spr-text
Parameter | Details |
|---|---|
| visitId | Identifier of the visit of which you want spr text. |
Result
The response of this request will return the text of surgical pathology report of specified visit identifier.
Example
| 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 |