...
Participant Registration REST API takes following parameters through json request
| Parameter | Description |
|---|---|
| ppId | Protocol Participant Identifier is unique identifier forof participant registered for collection protocol. PPId is key of participant integration between caTissue Plus and external app. It is mandatory parameter. |
| birthDate [optional] | Date of birth of participant. |
| gender [optional] | Gender of participant. |
| enrollmentDate | Date of participant getting register.It is mandatory parameter. |
| studyId | External application study identifier . It is mandatory parameterto which collection protocol is mapped. |
| appName | External Application Name to which caTissue Plus is integrated. It is mandatory parameter. |
Result :
Result contains status of participant registration.if status is OK then contains created collection protocol registration details.Result also contains message and erroneous fields if registration fails.
...
| URL | http://<host>:<port>/catissuecore/rest/ng/notifications/registration |
| Request | application/json |
| Method | POST |
| json | { "ppId": "1234", "gender": "Male Gender", "enrollmentDate": "2014-01-01", "birthDate": "1989-02-06", "studyId": "CS1", "appName": "OpenClinica" }
|
| Response | { "status": "OK", "message": "Participant registered successfully", "exception": null, "erroneousFields": null, "cprDetail" : { "id":101, "cpId":501, "ppId": "1234", "barCode":"111111", "activityStatus": "Active", "registrationDate": "2014-29-12", "participantDetail": [ { "activityStatus" : "Active", "ethnicity" : "Unknown", "firstName" : "Jhon", "lastName" : "Dep", "gender" : "Male Gender", " , enrollmentDate: "2014-01-01", birthDate: "1989-02-06", studyId: "CS1", appName: "OpenClinica" }id" : "1", "pmiCollection" : [ { "mrn" : "324r6", "siteName" : "Lab2" } ], "race" : [ "Asian" ], "ssn" : "123-45-6789" } ] } } |
Response Status :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Participant registered successfully |
| 400 | All requests | Invalid parameters, e.g duplicate label, duplicate barcode, invalid class Name etc |
| 401 | All requests | Authorization failed, User doesn’t have Authority to register participant for the given collection protocol |
| 500 | All requests | Internal server error, Encountered server error while performing operations |