Versions Compared

Key

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

Notification from External Application for Participant Registration :-

1) Register new participant 

List Of Mandatory Fields:

  1. ppId
  2. enrollmentDate
  3. studyId  (Identifier of External Applications Study)
  4. appName (External Application Name)

 

MethodURL
POSTcatissuecore/rest/ng/notifications/
Requestapplication/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
200All resourcesParticipant registered successfully
400All requestsInvalid parameters, e.g  duplicate label, duplicate barcode, invalid class Name etc
401All requestsAuthorization failed, User doesn’t have Authority to register participant for the given collection protocol
500All requestsInternal server error, Encountered server error while performing operations

 

2) Update Participant Registration

List Of Mandatory Fields:

  1. ppId
  2. enrollmentDate
  3. studyId  (Identifier of External Applications Study)
  4. appName (External Application Name)
MethodURL
PUTcatissuecore/rest/ng/notifications/
Requestapplication/json
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"
}

}

Error Cases :

...

code

...

Applies to

...

Status Message

...

List of API's available of notifications from External Applications