Use of this REST API is to update participant registration notified from external application. caTissue Plus can be integrate with External Application external applications like Openclinica. Participants updated under study of in external application applications can be updated in caTissue Plus using this REST API. There is mapping between collection protocol and studies of external application.
You can
Json Parameteres :
can register participant from external applications through PUT URL
http://<host>:<port>/catissuecore/rest/ng/notifications/registration
Parameter Details :
Update Participant Registration REST API takes following parameters through json request
| Parameter | Description |
|---|---|
| ppId | Unique Protocol Participant Identifier is a unique identifier for 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 on which participant getting registerregistered.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. |
| Method | URL |
| PUT |
Result :
Result contains status of update participant registration.if status is OK then also contains collection protocol registration details.Result also contains message and erroneous fields if update fails.
Example :
| URL | http://<host>:<port>/catissuecore/rest/ng/notifications/registration |
| Request | application/json |
| Method | PUT |
| json | { "ppId": "1234", "gender": "Female Gender", "enrollmentDate": "2014-29-12", "birthDate": "1989-02-06", "studyId": "CS1", "appName": "MirthOpenClinica" } |
| Response | { "status": "OK", "message": "Participant registration updated successfully", "exception": null, "erroneousFields": null, "cprDetail" : { "id":101, "cpId":501, "ppId": "1234", gender:"Male Gender", "barCode":"111111", "activityStatus": "Active", "registrationDate": "2014-29-12", "participantDetail": [ { "activityStatus" : "Active", "ethnicity" : "Unknown", "firstName" : "Jhon", "lastName" : "Dep", "gender" : "Female Gender", "id" : "1", "pmiCollection" : [ { "mrn" : "324r6", birthDate: "1989-02-06", } |
...
"siteName" : "Lab2" } ], "race" : [ "Asian" ], "ssn" : "123-45-6789" } ] } } |
Response Status :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Participant registration updated successfully |
| 400 | All requests | Invalid parameters, e.g duplicate ppId, invalid studyId, invalid applicationName etc |
| 401 | All requests | Authorization failed, User doesn’t doesn't have Authority to update participant registration for the given collection protocol |
| 500 | All requests | Internal server error, Encountered server error while performing operations |