Versions Compared

Key

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

...

Participant Registration REST API takes following parameters through json request


ParameterDescription
ppIdUnique Protocol Participant Identifier is unique 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.

 

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.

API Example :

URLhttp://<host>:<port>/catissuecore/rest/ng/notifications/registration
Requestapplication/json
MethodPOST
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" }
}

...