Versions Compared

Key

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

...

openspecimen/rest/ng/participants/{participant_id}

Use this resource to partially update retrieve an existing participant's details in the from OpenSpecimen application. Use HTTP GET method to call this API.

...

json
URLhttp[s]:<host>:<port>/catissuecore/rest/ng/participants/1
MethodGET
content-typeapplication/json
response

 

response
Code Block
{


"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 :

Invalid parameters, e.g  duplicate SSN, duplicate MRN etc
code
Applies to
Status Message
200All resourcesParticipant registered successfully400All requests
401All requestsAuthorization failed, User doesn’t have privileges to register Participants
404All requestsParticipant not found, Participant with the given identifier is not present in the system
500All requestsInternal server error, Encountered server error while performing operations