Get study visit schedule
get
/ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Retrieves the visit schedule in a study.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
-
version(required): string
Study version. Example: "1.0.0.1"
-
visitid(required): string(uuid)
Visit identifier
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : StudyEventScheduleDto v1.0
Type:
object
Title:
StudyEventScheduleDto v1.0
Study event schedule details.
Show Source
-
delay(required): object
StudyEventScheduleDelay v1.0
Title:
StudyEventScheduleDelay v1.0
study event schedule delay. -
delayWindow(required): object
StudyEventScheduleDelayWindow v1.0
Title:
StudyEventScheduleDelayWindow v1.0
Study event schedule delay window. -
outOfWindowHardStopEnforced: integer
(int32)
Out off window hard stop enforcedExample:
1
-
outOfWindowVisitApprovalGranted: integer
(int32)
Out off window visit approval grantedExample:
1
-
projectedFromRefId(required): string
(uuid)
Projected from reference GUID
Nested Schema : StudyEventScheduleDelay v1.0
Type:
object
Title:
StudyEventScheduleDelay v1.0
study event schedule delay.
Show Source
-
days: integer
(int32)
Minimum Value:
0
Study event schedule delay in daysExample:1
-
hours: integer
(int32)
Minimum Value:
0
Study event schedule delay in hoursExample:1
Nested Schema : StudyEventScheduleDelayWindow v1.0
Type:
object
Title:
StudyEventScheduleDelayWindow v1.0
Study event schedule delay window.
Show Source
-
after: object
StudyEventScheduleDelay v1.0
Title:
StudyEventScheduleDelay v1.0
study event schedule delay. -
before: object
StudyEventScheduleDelay v1.0
Title:
StudyEventScheduleDelay v1.0
study event schedule delay.
500 Response
Error
Root 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 : Object
Type:
object
Title:
Object
Object with error details information.