participants/bulk endpoint is used to add a list of participant IDs to the Study/Site. User can add the bulk list of participant IDs either at Study level or at the Site level.

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

Usage:

At Study level:

At Site level:

Request Parameters:

  • Content-Type: text/xml
  • filename=”participantList.csv”

participantList.csv” should be replaced with a CSV file that contains the list of participant IDs that need to be added to the study.

Here’s a link to the sample CSV file for adding two participant IDs – JUNO-005 and JUNO-006

Response Body on Success:

{
  "uploadCount": 2,
  "failureCount": 0,
  "message": "SUCCESS",
  "createdBy": "Bhatnagar Renuka",
  "createdAt": "11-9-2018 12:09:22",
  "failedParticipants": [],
  "participants": [
    {
      "subjectKey": "JUNO-005",
      "status": "Available"
    },
    {
      "subjectKey": "JUNO-006",
      "status": "Available"
    }
  ]

Response Body on Operation Failure:

{
  "uploadCount": 0,
  "failureCount": 0,
  "message": "errorCode.notSupportedFileFormat",
  "createdBy": "Bhatnagar Renuka",
  "createdAt": "11-9-2018 12:11:47",
  "failedParticipants": [],
  "participants": []
}

Response Body on Operation Success but there are some failed to load participant IDs:

{
  "uploadCount": 1,
  "failureCount": 1,
  "message": "SUCCESS",
  "createdBy": "Specialist Data ",
  "createdAt": "11-9-2018 12:25:28",
  "failedParticipants": [
    {
      "subjectKey": "JUNO-006",
      "message": [
        "errorCode.participantIDNotUnique"
      ]
    }
  ],
  "participants": [
    {
      "subjectKey": "JUNO-007",
      "status": "Available"
    }
  ]
}

In Case of failure to perform the operation or to add a particular 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: Bulk operation has failed:

errorCode.studyNotExist

Study OID specified in the request is not found.

errorCode.siteNotExist

Site OID specified in the request is not found.

errorCode.bulkUploadNotSupportSystemGeneratedSetting

Bulk particpant ID upload is not supproted when participant ID setting is set to System-generated.

errorCode.notSupportedFileFormat

File format is not supported. Only CSV files are accepted.

errorCode.noSufficientPrivileges

User does not have sufficient privileges to perform this operation.

errorCode.noRoleSetUp

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

Scenario: Bulk operation is successful, but response has some failed Participants

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.