openspecimen/rest/ng/participants/matchParticipants
Use this resource to create new participant get matching participants in the OpenSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format.
...
| URL | http[s]:<host>:<port>/openspecimen/rest/ng/participants |
| Method | POST |
| content-type | application/json |
| Method | POST |
| json | { "ethnicity" : "Unknown", "firstName" : "Jhon", "gender" : "Male Gender", "lastName" : "Dep", "pmiCollection" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "race" : [ "Asian" ], "ssn" : "123-45-6789" } |
Response | [ 1]0: { "ethnicity" : "Unknown", "firstName" : "Jhon", "gender" : "Male Gender", "lastName" : "Dep", "pmiCollection" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "race" : [ "Asian" ], "id" : "1", "ssn" : "123-45-6789" } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Participant registered successfully |
| 400 | All requests | Invalid parameters, e.g duplicate SSN, duplicate MRN, invalid race etc |
| 401 | All requests | Authorization failed, User doesn’t have privileges to register Participants |
| 500 | All requests | Internal server error, Encountered server error while performing operations |