openspecimen/rest/ng/visits/{visitId}/spr-file
Use this resource to download surgical pathology report (SPR) 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:
...
...
...
Summary
This page contains documentation of REST API to download surgical pathology report.
Request Details
Use following http GET request to download surgical pathology report.
http[s]:<host>:<port>/openspecimen/rest/ng/visits/{visitId}/spr-file
Use this URL to download surgical pathology report (SPR) from OpenSpecimen application.
...
Parameter | Details |
|---|---|
| visitId | Identifier of the visit |
Result
The response of this request will download the surgical pathology report of specified visit identifier.
Below is the example of the download surgical pathology report (SPR)
Example
| URL | http[s]:<host>:<port>/openspecimen/rest/ng/visits/1/spr-file |
| Method | GET |
| contentContent-typeType | application/json |
Response | File i.e Downloads the Surgical Pathology Report. |
...
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Surgical Pathology Report (SPR) downloaded uploaded successfully |
| 401 | All requests | Authorization failed, User doesn't have AuthorityUser does not have sufficient rights to perform this operation |
| 404 | All requests | Visit not found, Visit with given identifier does not exist in the systemspecified in requested operation does not exists |
| 500 | All requests | Internal server error, Encountered server error while performing operations |
...
| Server Error. Report this error to system administrator |