This API is available to create a participant in caTissue. You can create the participant at the URL using the HTTP PUT method: http[s]:<host>:<port>/catissuecore/rest/ng/participants/{participant_id}
Below are the JSON attributes which need to be sent in the request body:
Parameter | Details |
|---|---|
| firstName | First name of the participant |
| middleName | Middle name of the participant |
| lastName | Last name of the participant |
| ssn | Social security number of participant |
| birthDate | date of birth of participant |
| vitalStatus | Vital status of the participant. |
| deathDate | date of death participant |
| gender | gender of the participant, permissible values are {Male Gender, Female Gender, Unknown, Unspecified} |
| race | Patient's racial origination, permissible values are: {American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or other Pacific Islander, Not Reported, Unknown, White} |
| ethnicity | Patient's ethnicity status. permissible values are: {Hispanic or Latino, Not Hispanic or Latino, Not Reported, Unknown} |
| Sex Genotype | The genetic constitution of the individual; the characterization of the genes. Permissible values are: {XX Genotype, XY Genotype, XXX, Klinefelter’s Syndrome, XXXY syndrome, XXYY syndrome, Mosaic including XXXXY, Penta X syndrome} |
| 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>/catissuecore/rest/ng/participants/{participant_id}
Use this URL to update the participant for the given identifier.
Result:
The response of this request will contains the details of the updated participant.
Below is the example of the update participant:
| URL | http[s]:<host>:<port>/catissuecore/rest/ng/participants/1 |
| content-type | application/json |
| json | { "ethnicity" : "Unknown", "firstName" : "Jhon", "gender" : "Male Gender", "lastName" : "Dep", "pmiCollection" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "race" : [ "Asian" ], "ssn" : "123-45-6789" } |
| response | { "activityStatus" : "Active", "ethnicity" : "Unknown", "firstName" : "John", "gender" : "Male Gender", "id" : "1", "lastName" : "Depp", "pmiCollection" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "race" : [ "Asian" ], "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 PPID, duplicate barcode 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 |