Update visit schedule
put
/ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}
Updates visit schedule in your study.
Request
Path Parameters
-
fromEventRefId(required): string(uuid)
From Event Ref Id
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
-
version(required): string
Study version. Example: "1.0.0.1"
-
visitid(required): string(uuid)
Visit identifier
Supported Media Types
- */*
Root Schema : StudyEventScheduleDto v4.0
Type:
object
Title:
StudyEventScheduleDto v4.0
Study event schedule details.
Show Source
-
branchId: string
(uuid)
Visit branch GUID
-
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. -
outOfWindowAlert: string
(string)
Outside Visit Window AlertExample:
OFF
-
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.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : StudyEventScheduleDto v4.0
Type:
object
Title:
StudyEventScheduleDto v4.0
Study event schedule details.
Show Source
-
branchId: string
(uuid)
Visit branch GUID
-
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. -
outOfWindowAlert: string
(string)
Outside Visit Window AlertExample:
OFF
-
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
Nested Schema : details
Type:
object