16.3 participants (Add participants or Get list of participants)

Note: User needs to be authenticated before calling this service. Based on the user’s privileges the operation would be allowed.

Usage:

Get a list of Participants

At Study level:

At Site level:

Response Body:

{
  "studyParticipants": [
    {
      "subjectKey": "Boston-001",
      "status": "Available",
      "createdBy": "rbhatnagar",
      "createdAt": "Aug 31, 2018 12:00:00 AM",
      "lastModified": null,
      "lastModifiedBy": ""
    },
    {
      "subjectKey": "Boston-002",
      "status": "Available",
      "createdBy": "rbhatnagar",
      "createdAt": "Aug 31, 2018 12:00:00 AM",
      "lastModified": null,
      "lastModifiedBy": ""
    }
}

In Case of failure to perform the operation to get the list of participant IDs, an appropriate errorCode would be returned. User can plan their follow-up action based on these errorCodes.

Below is the list of errorCodes with their descriptions:

Scenario: Get participant list operation has failed:

errorCode.noRoleSetUp

User has no roles setup under the given Study/Site.

errorCode.studyNotExist

Study OID specified in the request is not found.

errorCode.siteNotExist

Site OID specified in the request is not found.

Adding a Participant

At Study level:

At Site level:

Request Body when Participant ID setting = Manual entry:

{
  "subjectKey": "string"
}

Within the request body, replace ‘string’ with the desired participant ID.

When study is set to have system-generated participant ID, then request does not require to have body. Empty curly braces are enough to add a new participant.

Response Body when Success:

{
  "subjectKey": "JUNO-003",
  "status": "Available"
}

Response Body when Failure:

{
  "subjectKey": null,
  "message": [
    "The study identifier you provided:S_JUNO(EST) is not valid."
  ]
}

In case of failure to perform the operation or to add the participant ID, an appropriate errorCode would be returned. User can plan their follow-up action based on these errorCodes.

Below is the list of errorCodes with their descriptions:

Scenario: Add participant operation has failed:

errorCode.noSufficientPrivileges

User does not have sufficient privileges to perform this operation.

errorCode.noRoleSetUp

User has no roles setup under the given Study/Site.

errorCode.studyNotExist

Study OID specified in the request is not found.

errorCode.siteNotExist

Site OID specified in the request is not found.

Scenario: Add participant operation is successful, but Participant ID has failed

errorCode.participantIDContainsUnsupportedHTMLCharacter:

Participant ID contains unsupported HTML (<, >) characters.

errorCode.participantIDLongerThan30Characters:

Participant ID exceeds 30 characters limit.

errorCode.participantIDNotUnique:

Participant ID already exists.

errorCode.participantsEnrollmentCapReached:

Participant Enrollment Limit has reached. No new participants can be added.