openspecimen/rest/ng/participants/match
...
| URL | http[s]:<host>:<port>/openspecimen/rest/ng/participants/match |
| Method | POST |
| content-type | application/json |
| Method | POST |
| json | { "lastName" : "Dep", "pmis" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "uid" : "123-45-6789" } |
Response | [ 1]0: { "matchedAttrs": [1] 0: "pmi" "participant":{ "lastName" : "Dep", "pmis" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "id" : "1", "uid" : "123-45-6789" } } |
Note:
matchedAttrs contains list of input attributes against which matching participant was found. The values could any of these ["empi" | "uid" | "pmi" | "lnameAndDob"]
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 |