Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can register participant from external applications through PUT URL

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

Parametere Details : 

Update Participant Registration REST API takes following parameters through json request

...

ParameterDescription
ppIdUnique identifier for participant registered for collection protocol. PPId is key of participant integration between caTissue Plus and external app. It is mandatory parameter.
birthDateDate of birth of participant.
genderGender of participant.
enrollmentDateDate of participant getting register.It is mandatory parameter.
studyIdExternal application study identifier. It is mandatory parameter.
appNameExternal Application Name to which caTissue Plus is integrated. It is mandatory parameter.

API 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 :

URLhttp://<host>:<port>/catissuecore/rest/ng/notifications/registration
Requestapplication/json
MethodPUT
json

{

"ppId": "1234",

"gender": "Female Gender",

"enrollmentDate": "2014-29-12",

"birthDate": "1989-02-06",

"studyId": "CS1",

"appName": "Mirth"

}

Response

{
status: "OK"
message: "Participant registration updated successfully"
exception: null
erroneousFields: null
cprDetail: { ppId: "1234", gender:"Male Gender", enrollmentDate: "2014-29-12", birthDate: "1989-02-06", studyId: "CS1", appName: "OpenClinica"}

}

...