Get list of subjects based on search input
get
/ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Retrieves list of subjects based on search input parameters, for the sites having a given study version. This API request returns mHealthSubjectId as part of the response body.
The supported parameters are:
The supported parameters are:
- readyToSign
- readyToVerify
- signed
- verified
- freezed
- signedandverified
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.
Query Parameters
-
containsSearchKeyword(required): array[string]
List of search words containing the subject number.
-
exactSearchKeyword(required): array[string]
List of search words matching exactly the subject number.
-
limit(required): integer(int32)
Minimum Value:
0Number of subjects. -
offset(required): integer(int32)
Minimum Value:
0Starting offset. -
order(required): string
asc or desc
-
signVerifyStatus(required): string
Status of Sign / Verify.
-
siteId(required): string(uuid)
Site for which you want to retrieve subjects.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Nested Schema : SubjectDto6
Type:
Show Source
object-
codeBreak: string
-
comment: string
Minimum Length:
0Maximum Length:2048 -
description: string
Minimum Length:
0Maximum Length:500 -
dob: string
(date-time)
-
enrollmentFailure: string
Minimum Length:
0Maximum Length:255 -
enrollmentOverride: string
Minimum Length:
0Maximum Length:255 -
eventType: string
-
freezedStatus: string
-
fromStudyId: string
(uuid)
-
gender: string
Minimum Length:
0Maximum Length:10 -
id: string
(uuid)
-
informedConsentDate: string
(date-time)
-
lastSigned: string
-
mhealthSubjectId: string
(uuid)
-
objectVersionNumber: number
-
reason: string
Minimum Length:
0Maximum Length:255 -
screeningDate: string
(date-time)
-
screeningFailure: string
Minimum Length:
0Maximum Length:255 -
signedStatus: string
-
siteId: string
-
state(required): string
Minimum Length:
0Maximum Length:100 -
stateDate: string
(date-time)
-
studyId: string
-
studyVersion(required): string
-
subjectNumber(required): string
Minimum Length:
0Maximum Length:500 -
subjectTransferId: string
(uuid)
-
subjNumSiteOrgId: string
-
userId: string
(uuid)
-
verifiedStatus: string
-
versionStart: string
(date-time)
400 Response
Bad request.
Nested Schema : result
Type:
objectNested Schema : details
Type:
object