openspecimen/rest/ng/participants/matchParticipants
Use this resource to get matching participants in the OpenSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format. This will match against the below attributes only.
Below are the attributes which need to be sent in the request body:
Parameter | Details |
|---|---|
| lastName | Last name of the participant |
| ssn | Social security number of participant |
| birthDate | date of birth of participant |
| pmiCollection | collection of Participant's medical record number used in their medical treatment. |
| mrn | Participant's medical record number used in their medical treatment. |
| siteName | Name of the physical location. |
http[s]:<host>:<port>/openspecimen/rest/ng/participants/match
Use this URL to add participant in OpenSpecimen application.
Result:
The response of this request will contains the details of the created participant.
Below is the example of the create participant:
| URL | http[s]:<host>:<port>/openspecimen/rest/ng/participants |
| Method | POST |
| content-type | application/json |
| Method | POST |
| json | { "lastName" : "Dep", "pmiCollection" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "ssn" : "123-45-6789" } |
Response | [ 1]0: { "lastName" : "Dep", "pmiCollection" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "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 |