Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

openspecimen/rest/ng/visits/{visitId}/spr-file/{file}

Use this resource to upload  surgical pathology report (SPR) for visit. 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. 

URL : 

Use following url to upload surgical pathology report (SPR)

http[s]:<host>:<port>/openspecimen/rest/ng/visits/{visitId}/spr-file/{file}


Result :

Response will contain file name of uploaded report.

 

Example:

 

URL

http://<host>:<port>/openspecimen/rest/ng/visits/1/spr-file/{fileName:spr.pdf}

MethodPOST
Requestapplication/json
json

{}

 

Response

spr.txt

 

Error Cases :

code
Applies to
Status Message
200All resourcesSurgical Pathology Report (SPR) has been uploaded successfully
400All requestsInvalid parameters, e.g  duplicate CP title, blank CP Title etc
401All requestsAuthorization failed, User doesn’t have Authority
404All requestsVisit not found, Visit with given identifier does not exist in the system
500All requestsInternal server error, Encountered server error while performing operations