Versions Compared

Key

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

...

URLhttp[s]:<host>:<port>/openspecimen/rest/ng/participants/match
MethodPOST
content-typeapplication/json
MethodPOST
Body


Code Block
{
  "lastName" : "Dep",
  "pmi" :  {
    "mrn" : "324r6",
    "siteName" : "Lab2"
  } ,
  "uid" : "123-45-6789",
  "reqRegInfo": true
}


Response


Code Block
[
  {
    "matchedAttrs": ["pmi", "uid"]
    "participant": {  
      "lastName" : "Dep",
      "pmis" : [{ 
        "mrn" : "324r6",
        "siteName" : "Lab2"
      }],
      "uid" : "123-45-6789"
      "id" : "1",

      /** other participant attributes **/

      "registeredCps": [/*/* registeredCps array is populated only if reqRegInfo = true in matching request */
      "registeredCps": [
        {
          "cpShortTitle": "Lung Cancer",
          "registrationDate": 1437282466892,
          "ppid": "LC-007"
        }


        /* other registrations, if any */
      ]
    }
]


Note:

matchedAttrs contains list of input attributes against which matching participant was found. The values could any of these ["empi" | "uid" | "pmi" | "lnameAndDob"]

...