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:
Parameter | Details |
|---|---|
| visitId | Identifier of the visit of which you want to download spr. |
http[s]:<host>:<port>/openspecimen/rest/ng/visits/{visitId}/spr-file
Use this URL to download surgical pathology report (SPR) from OpenSpecimen application.
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)
| URL | http[s]:<host>:<port>/openspecimen/rest/ng/visits/1/spr-file |
| Method | GET |
| content-type | 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 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 |