Participant Registration From External Applications

Use of this REST API is to register participant notified from external application. caTissue Plus can be integrate with external applications like Openclinica. Participants created under study in external applications can be registered 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 POST URL

http://<host>:<port>/catissuecore/rest/ng/notifications/registration

Parameter Details :

Participant Registration REST API takes following parameters through json request

Parameter	Description
ppId	Protocol Participant Identifier is unique identifier of 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.
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 participant registration.if status is OK then contains created collection protocol registration details.Result also contains message and erroneous fields if registration fails.

Example :

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