List Of Mandatory Fields:
- ppId
- enrollmentDate
- studyId (Identifier of External Applications Study)
- appName (External Application Name)
...
Use of this REST API is to update participant registration notified from external application. caTissue Plus can be integrate with external applications like Openclinica. Participants updated under study in external applications can be updated in caTissue Plus using this REST API. There is mapping between collection protocol and studies of external application.
You 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 | 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. |
| birthDate [optional] | Date of birth of participant. |
| gender [optional] | Gender of participant. |
| enrollmentDate | Date on which participant getting registered. |
| studyId | External application study identifier to which collection protocol is mapped. |
| appName | External Application Name to which caTissue Plus is integrated. |
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", "barCode":"111111", gender "activityStatus": "Male GenderActive", enrollmentDate "registrationDate": "2014-29-12", } |
...
", "participantDetail": [ { "activityStatus" : "Active", "ethnicity" : "Unknown", "firstName" : "Jhon", "lastName" : "Dep", "gender" : "Female Gender", "id" : "1", "pmiCollection" : [ { "mrn" : "324r6", "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 |