Get subjects for the specified study and mode
get
/ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects
Lists all subjects for the specified study and mode. It only returns subjects for the sites to which the requesting user has access and details described in the Response section for each subject.
Rights: DataCaptureSubjectGet and SubjectDataClassificationGet.
Rights: DataCaptureSubjectGet and SubjectDataClassificationGet.
Request
Path Parameters
-
mode(required): string
Mode of the study. Accepts test, active, or training.
-
studyId(required): string
ID of the study for which you want to get the list of subjects.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
400 Response
Bad request.
Root Schema : DcsResponse
Type:
Show Source
object-
errorData: object
ErrorResponseData
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
-
result: object
result
-
status: string
-
version: integer
(int32)
Nested Schema : ErrorResponseData
Type:
objectStructure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
-
details: string
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.Example:
User role is missing required permission REPORTING_VIEW. Field: userId -
errorCode: string
Application or business-specific error code representing the error type.Example:
REPT_401 -
errorMessage: string
Human-readable error message describing the failure or issue.Example:
Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type:
object