Got feedback or spotted a mistake?
Leave a comment at the end of this page or email contact@krishagni.com
Get Participant
openspecimen/rest/ng/participants/{participant_id}
Use this resource to retrieve an existing participant's details from OpenSpecimen application. Use HTTP GET method to call this API.
Here participant_id refers to the actual identifier of the participant to which user wants to retrieve.
http[s]:<host>:<port>/openspecimen/rest/ng/participants/{participant_id}
Use this URL to retrieve the participant for the given identifier.
Result:
The response of this request will contains the details of the updated participant.
Below is the example of the update participant:
URL | http[s]:<host>:<port>/catissuecore/rest/ng/participants/1 |
Method | GET |
content-type | application/json |
response | { "activityStatus" : "Active", "ethnicity" : "Unknown", "firstName" : "John", "gender" : "Male Gender", "id" : "1", "lastName" : "Depp", "pmis" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "race" : [ "Asian" ], "uid" : "123-45-6789" } |
Error Cases :
code | Applies to | Status Message |
---|---|---|
200 | All resources | Participant registered successfully |
401 | All requests | Authorization failed, User doesn’t have privileges to register Participants |
404 | All requests | Participant not found, Participant with the given identifier is not present in the system |
500 | All requests | Internal server error, Encountered server error while performing operations |
Got feedback or spotted a mistake?
Leave a comment at the end of this page or email contact@krishagni.com