Get subjects for the specified study and mode
get
/ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/subjects
Lists all subjects with lock status for the specified study and mode. It only returns subjects for the sites to which the requesting user has access and describes details in the Response section for each subject with lock status and includes completion and withdrawal dates.
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
Root Schema : schema
Type:
Show Source
array-
Array of:
object SubjectRespDto14
Subject response details including replacement randomization and query status, building upon SubjectRespDto13
Nested Schema : SubjectRespDto14
Type:
objectSubject response details including replacement randomization and query status, building upon SubjectRespDto13
Show Source
-
canBeCompleted: boolean
Indicates if the subject has met conditions to be completedExample:
true -
canBeReplaced: boolean
Indicates if the subject can be replacedExample:
true -
canBeUndoWithdrawn: boolean
Indicates if a withdrawn subject can be undoneExample:
true -
codeBreak: string
Code break note if applicableExample:
N -
comment: string
Minimum Length:
0Maximum Length:2048Comment for latest subject updateExample:Initial enrollment -
description: string
Minimum Length:
0Maximum Length:500Free text description for the subjectExample:Screened subject -
dob: string
(date-time)
Date of birth
-
ehrLinkStatus: number
EHR link status code for the subjectExample:
1 -
enrollmentFailure: string
Minimum Length:
0Maximum Length:255Reason for enrollment failure, if anyExample:Consent withdrawn -
enrollmentOverride: string
Minimum Length:
0Maximum Length:255Enrollment override note if appliedExample:Subject Enrollment Overridden -
eventType: string
Type of event associated with the subjectExample:
Screened -
freezedStatus: string
Freeze status of the subjectExample:
FROZEN -
fromStudyId: string
(uuid)
Origin study identifier from which the subject was transferred
-
gender: string
Minimum Length:
0Maximum Length:10Gender valueExample:[{"value":"1","label":"male"}] -
hasLockData: boolean
Indicates whether lock related data exists for the subjectExample:
false -
id: string
(uuid)
Unique identifier of the subject
-
incompleteVisits: integer
(int32)
Number of incomplete visits for the subjectExample:
1 -
informedConsentDate: string
(date-time)
Informed consent dateExample:
2025-09-25T09:00:00Z -
lastSigned: string
(date-time)
Timestamp when the subject was last signedExample:
2025-10-16T14:30:31.892Z -
lockedDateTime: string
(date-time)
Timestamp when the subject was lockedExample:
2025-10-16T14:30:31.892Z -
lockedInStudyVersion: string
Study version in which the subject is lockedExample:
3.0.0.4 -
lockedStatus: string
Lock status of the subjectExample:
UNLOCKED -
mhealthSubjectId: string
(uuid)
Identifier of the subject in mHealth system
-
objectVersionNumber: number
Object version number used for concurrency controlExample:
14 -
operationType: string
Operation type for the subject eventExample:
MODIFIED -
previousSubjectNumber: string
Previous subject number if renumbered or transferredExample:
SUBJECT-0001-OLD -
randomizationNumber: string
Randomization number for the subjectExample:
RND-001 -
reason: string
Minimum Length:
0Maximum Length:255Reason for latest subject updateExample:Protocol break happened -
replaceRand: string
Replacement randomization identifier if applicableExample:
Y -
screenFailureComment: string
Additional comment for screen failureExample:
Subject breached protocols -
screenFailureDate: string
(date-time)
Date when the subject was marked as screen failureExample:
2025-10-16T14:30:31.892Z -
screeningDate: string
(date-time)
Screening date if applicableExample:
2025-10-01T10:00:00Z -
screeningFailure: string
Minimum Length:
0Maximum Length:255Reason for screening failure, if anyExample:Inclusion criteria not met -
screeningNumber: string
Screening number assigned to the subjectExample:
SCR-0001 -
signedStatus: string
Signed status of the subjectExample:
SIGNED -
siteId: string
Site identifier in uppercase hex formatExample:
ABCDEF1234567890ABCDEF1234567890 -
softwareVersionNumber: number
Software version number associated with the eventExample:
14 -
sourceTimeStamp: string
(date-time)
Source system timestamp for the subject payloadExample:
2025-10-16T14:30:31.892Z -
state(required): string
Minimum Length:
0Maximum Length:100Lifecycle state of the subjectExample:ACTIVE -
stateDate: string
(date-time)
Timestamp when the subject transitioned to current stateExample:
2025-10-16T14:30:31.892Z -
studyCompletionDate: string
(date-time)
Date when the subject completed the studyExample:
2025-10-16T14:30:31.892Z -
studyId: string
Study identifier in uppercase hex formatExample:
ABCDEF1234567890ABCDEF1234567890 -
studyVersion(required): string
Study version stringExample:
3.0.0.1 -
subjectNumber(required): string
Minimum Length:
0Maximum Length:500Human readable subject numberExample:SUBJ-0001 -
subjectSiteSerialNumber: string
Site-level serial number assigned to the subjectExample:
SITE-0001-001 -
subjectStudySerialNumber: string
Study-level serial number assigned to the subjectExample:
STUDY-0001-001 -
subjectTransferId: string
(uuid)
Identifier of a subject transfer if applicable
-
subjNumSiteOrgId: string
Subject number site organization identifierExample:
SITE-ORG-0001 -
unResolvedQueries: integer
(int32)
Number of unresolved queries for the subjectExample:
2 -
userId: string
(uuid)
User identifier associated with the subject modification
-
verifiedStatus: string
Verified status of the subjectExample:
VERIFIED -
versionEnd: string
(date-time)
End timestamp of the subject version recordExample:
2025-10-16T14:30:31.892Z -
versionStart: string
(date-time)
Start timestamp of the subject versionExample:
2025-10-16T14:30:31.892Z -
withdrawalComment: string
Additional comment provided for withdrawalExample:
Subject breached protocols -
withdrawalDate: string
(date-time)
Date when the subject was withdrawnExample:
2025-10-16T14:30:31.892Z -
withdrawalReason: string
Reason provided when the subject is withdrawnExample:
Not applicable
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