[Deprecated]: Get visit schedule
get
/ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visitschedules
Deprecated: Use latest version instead. Retrieves the visit schedule of a study.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
-
version(required): string
Study version. Example: "1.0.0.1"
Query Parameters
-
unscheduledVisits(required): string
Include unscheduled visit or not.Default Value:
include
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object StudyVisitScheduleDto v2.0
Title:
StudyVisitScheduleDto v2.0
Study visit schedule details.
Nested Schema : StudyVisitScheduleDto v2.0
Type:
object
Title:
StudyVisitScheduleDto v2.0
Study visit schedule details.
Show Source
-
dynamic: boolean
Yes - if visit dynamic.Example:
false
-
eventType: string
Event randomization typeExample:
Blinded
-
formCount: integer
(int32)
Visit forms countExample:
1
-
fromVisitId: string
(uuid)
Scheduled from visit GUID
-
fromVisitTitle: string
Scheduled from visit titleExample:
Week1
-
id: string
(uuid)
Visit schedule GUID
-
kitCount: integer
(int32)
Visit kits countExample:
1
-
lastRequired: boolean
Yes - if visit last required.Example:
false
-
randomizationId: string
(uuid)
Randomization GUID
-
refName: string
Country nameExample:
WEEK2
-
repeating: boolean
Yes - if visit repeating.Example:
false
-
required: integer
(int32)
Visit scheduling delay window after (hours).Example:
1
-
screening: integer
(int32)
1 - visit is screeningExample:
1
-
sequenced: integer
(int32)
-
shortName: string
Event short nameExample:
Week2
-
studyId: string
(uuid)
Study GUID
-
studyVersionStart: string
(date-time)
Study version start
-
title: string
Visit titleExample:
Week2
-
type: string
Visit typeExample:
ONSITE
-
versionEnd: string
(date-time)
Version end
-
versionStart: string
(date-time)
Version start
-
visitScheduleId: string
(uuid)
Visit schedule GUID
500 Response
Error
Nested Schema : details
Type:
object