Notifications

Notification from External Application for Participant Registration :-

1) Register new participant

List Of Mandatory Fields:

Method	URL
POST	catissuecore/rest/ng/notifications/
Request	application/json
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: { ppId: "1234", gender:"Male Gender", enrollmentDate: "2014-01-01", birthDate: "1989-02-06", studyId: "CS1", appName: "OpenClinica" } }

Error Cases :

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

2) Update Participant Registration

List Of Mandatory Fields:

Method	URL
PUT	catissuecore/rest/ng/notifications/
Request	application/json
json	{ "ppId": "1234", "gender": "Female Gender", "enrollmentDate": "2014-29-12", "birthDate": "1989-02-06", "studyId": "CS1", "appName": "Mirth" }
Response	{ status: "OK" message: "Participant registered successfully" exception: null erroneousFields: null cprDetail: { ppId: "1234", gender:"Male Gender", enrollmentDate: "2014-29-12", birthDate: "1989-02-06", studyId: "CS1", appName: "OpenClinica" } }

Error Cases :

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 have Authority to update participant registration for the given collection protocol
500	All requests	Internal server error, Encountered server error while performing operations