Summary
This page contains documentation for upload surgical pathology report REST API. Use HTTP POST method to call this API by passing file as a path variable. In Surgical pathology report we upload report, deidentify report (if deidentifier is configured) and save report content in txt format.
Request Details
Use following url to upload surgical pathology report (SPR)
http[s]:<host>:<port>/openspecimen/rest/ng/visits/{visitId}/spr-file/{file}
Parameter | Details |
|---|---|
| visitId | Identifier of the visit. |
Result
Response will contain file name of uploaded report.
Example
| URL |
|
| Method | POST |
| Request | application/json |
Response | spr.txt |
Error Cases
Code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Surgical Pathology Report (SPR) has been uploaded successfully |
| 400 | All requests | Invalid parameters |
| 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 |