Get a list of all subjects
get
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{siteId}/subjects
Retrieves a list of all subjects based on study ID and site ID. Rights: DataCaptureSubjectGet
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
siteId(required): string(uuid)
ID of the site
-
studyId(required): string(uuid)
ID of the study
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : DCSSubject
Type:
object
DCS Subject details.
Show Source
-
codeBreak: string
Reveals the Treatment arm of a subject and the kits dispensed along with their description.Example:
Treatment arm B
-
description: string
Subject descriptionExample:
Subject undergoing treatment for asthma.
-
dob: string
(date-time)
Date of birth of the subject
-
enrollmentFailure: string
Reason for enrollment failureExample:
Enrollment failed.
-
enrollmentOverride: string
Enrollment OverrideExample:
Enrollment Override.
-
gender: string
Subject genderExample:
Male
-
id: string
(uuid)
DCS Subject ID
-
informedConsentDate: string
Informed consent dateExample:
06-MAR-19
-
mhealthSubjectId: string
(uuid)
ID of the mhealth subject
-
randomized: boolean
Indicate if subject is randomized.Example:
true
-
screeningDate: string
(date-time)
Date of screening of the subject at the site
-
screeningFailure: string
Reason for screening failureExample:
Screening failed.
-
siteId: string
ID of the siteExample:
82558921FCF14D2E9DA23FEDD57DDF7C
-
state: string
Allowed Values:
[ "New", "Active", "Screening_Initiated", "Screen_Failed", "Withdrawn", "Auto_Screen_Failed" ]
State of the subjectExample:Active
-
stateDate: string
(date-time)
Date on which the subject achieved the state mentioned
-
studyId: string
ID of the studyExample:
82558921FCF14D2E9DA23FEDD57DDF7C
-
studyVersion: string
Version of the studyExample:
1.0.0.5
-
subjectNumber: string
Subject number for the studyExample:
1-10
-
subjectTransferId: string
(uuid)
ID of the subject transfer
-
versionStart: string
(date-time)
Version Start
404 Response
The study identifier does not match any study identifiers in Clinical One.Or site not found.
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
500 Response
Internal server error
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object