Get list of visits status for a date range
get
/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visitstatus/dateRange/{subjectId}
Retrieves the list of visits status for a given date range mainly used by Integration hub.
Request
Path Parameters
-
subjectId(required): string(uuid)
Subject ID.
Query Parameters
-
endDate: string(date-time)
The end date until which you want to retrieve the visits details.
-
startDate: string(date-time)
The start date from which you want to retrieve the visits details.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Subjects success
Nested Schema : VisitsStatus
Type:
Show Source
object
-
associatedStudyVersion: string
Minimum Length:
0
Maximum Length:100
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
display: string
-
doseHoldAction: string
-
dynamicAllCycles: string
-
eventId: string
-
eventInstanceNum: integer
(int32)
-
eventType: string
-
freezedStatus: string
-
id: string
(uuid)
-
leadingDataelementId: string
-
lockedDateTime: string
(date-time)
-
lockedStatus: string
-
operationType: string
Minimum Length:
1
Maximum Length:16
-
reason: string
Minimum Length:
0
Maximum Length:255
-
repeatingFormCount: number
-
scheduledDate: string
(date-time)
-
scheduledEndDate: string
(date-time)
-
scheduledFromEventGUID: string
-
scheduledStartDate: string
(date-time)
-
scheduledWindowEndDate: string
(date-time)
-
scheduledWindowStartDate: string
(date-time)
-
signedStatus: string
-
siteId: string
-
studyVersion(required): string
Minimum Length:
0
Maximum Length:100
-
subjectId: string
-
userId: string
(uuid)
-
verifiedStatus: string
-
versionStart: string
(date-time)
-
visitAction: string
-
visitStartDate: string
(date-time)
-
visitStartDateLockedDateTime: string
(date-time)
-
visitStartDateLockedStatus: string
-
visitStatus: string
-
visitType: string
-
visitWindowWarning: string
400 Response
Bad request.
Root Schema : RestResponse
Type:
Show Source
object
-
errorData: object
ErrorResponseData
Title:
ErrorResponseData
Error Response Details Information -
result: object
result
-
status: string
-
version: integer
(int32)
Nested Schema : ErrorResponseData
Type:
object
Title:
ErrorResponseData
Error Response Details Information
Show Source
-
details: object
Object
Title:
Object
Object with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003
-
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
Nested Schema : result
Type:
object
Nested Schema : Object
Type:
object
Title:
Object
Object with error details information.