Get events within a date range
get
/ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/dateRange
Lists changes related to any subjects in the specified study and mode that occurred within the specified date range. 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.
Query Parameters
-
endDate(required): string(date-time)
The ending date and time (optional) for which you want to get events. If you don't specify the time, the date range stops before midnight (23:59:59 UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, dd-MMM-yyyy HH:mm, or dd-MMM-yyyy.
-
events: array[string]
The type of event you want to retrieve. Accepts (case-sensitive): New, Screened, Randomized, Withdrawn, Undo_Withdrawn, Transferred, Screen_Failed, Code_Break, Complete, Undo_Complete, Undo_ScrFailed, Visit_Complete, or DataElement_Change. You can specify more than one event type by repeating this parameter with different values.
-
startDate(required): string(date-time)
The starting date and time (optional) for which you want to get events. If you don't specify the time, the date range begins after midnight (UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, dd-MMM-yyyy HH:mm, or dd-MMM-yyyy.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Subjects success.
Nested Schema : SubjectDto8
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
-
operationType: string
-
previousSubjectNumber: string
-
reason: string
Minimum Length:
0Maximum Length:255 -
screeningDate: string
(date-time)
-
screeningFailure: string
Minimum Length:
0Maximum Length:255 -
signedStatus: string
-
siteId: string
-
softwareVersionNumber: number
-
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 -
subjectSiteSerialNumber: string
-
subjectStudySerialNumber: string
-
subjectTransferId: string
(uuid)
-
subjNumSiteOrgId: string
-
userId: string
(uuid)
-
verifiedStatus: string
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
400 Response
Bad request.
Nested Schema : result
Type:
objectNested Schema : details
Type:
object