16.3 participants (Add participants or Get list of participants)

The participants endpoint is used to perform the following actions:

• Add a Participant at the Study level
• Add a Participant at the Site level
• Get a list of Participants at the Study level
• Get a list of Participants at the Site level

The user must be authenticated prior to calling this service. The operation is allowed based on the user’s privileges.

Get a list of Participants

At Study level:

At Site level:

Response Body:

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

If the operation fails to get the list of participant IDs, an appropriate errorCode is returned. The user should plan the follow-up action based on the returned errorCodes.

Below is the list of errorCodes with their descriptions:

Scenario: Get participant list operation has failed:

• errorCode.noRoleSetUp: Authenticated user does not have a role assigned for the given Study/Site.
• errorCode.studyNotExist: The Study OID specified in the request is not found.
• errorCode.siteNotExist: The Site OID specified in the request is not found.

Adding a Participant

At Study level:

At Site level:

Request Body when Participant ID setting is “Manual entry”:

{
"subjectKey":"string"
}

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

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

Response Body on Success:

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

Response Body on Failure:

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

If the operation fails or does not add the participant ID, an appropriate errorCode is returned. The user should plan their follow-up action based on the returned errorCodes.

Below is the list of errorCodes with their descriptions:

Scenario: Add participant operation has failed:

• errorCode.studyNotExist: The Study OID specified in the request is not found.
• errorCode.siteNotExist: The Site OID specified in the request is not found.
• errorCode.noRoleSetUp: THe user has no role assigned for the given Study/Site.
• errorCode.noSufficientPrivileges: The user does not have sufficient privileges to perform this operation.

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

• errorCode.participantIDContainsUnsupportedHTMLCharacter: The Participant ID contains unsupported HTML (<, >) characters.
• errorCode.participantIDLongerThan30Characters: The Participant ID exceeds the 30 character limit.
• errorCode.participantIDNotUnique: The Participant ID already exists in the study.
• errorCode.participantsEnrollmentCapReached: The Participant Enrollment Limit has reached. No new participants can be added.