Update a visit
put
/ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/visits/{visitid}
Updates a visit in your 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)
Supported Media Types
- */*
Root Schema : VisitDto v9.0
Type:
objectTitle:
VisitDto v9.0Visit design.
Show Source
-
branchId: string
(uuid)
Branch Id
-
branchTitle: string
Visit Branch titleExample:
Branch 2 -
endVisitId: string
(uuid)
End visit ID
-
eventType: string
Visit event typeExample:
ScreeningVisit -
fullName: string
Concatenation of Visit Title and Branch title with hypenExample:
B1C01 - V01 -
id: string
(uuid)
Visit GUID
-
lastRequired: boolean
Yes - if Visit is last required.Example:
false -
randomization: string
(uuid)
Randomization GUID
-
repeatNumber(required): integer
(int32)
Times to repeat Visit Design.Example:
5 -
repeatVisit(required): boolean
Yes - if Visit Design is repeating.Example:
false -
requiredVisit(required): boolean
Yes - if Visit Design is required.Example:
false -
shortName(required): string
Minimum Length:
1Maximum Length:16Pattern:[a-zA-Z0-9]+Visit short nameExample:Week1 -
startVisitId: string
(uuid)
Start visit ID
-
studyVersion: string
Study versionExample:
1.0.0.1 -
studyVersionStatus: string
Study version statusExample:
TESTING -
timeLine: integer
(int32)
show in timeline. allows the designer to set when a visit can be shown to a user.Example:
1 -
title(required): string
Minimum Length:
1Maximum Length:64Visit titleExample:Week 2 -
visitDescription: string
Visit descriptionExample:
Regular 2 week visit -
visitStartDate: string
(date-time)
Visit start date timeExample:
2019-01-25T07:42:00.204Z
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array-
Array of:
object VisitDto v9.0
Title:
VisitDto v9.0Visit design.
Nested Schema : VisitDto v9.0
Type:
objectTitle:
VisitDto v9.0Visit design.
Show Source
-
branchId: string
(uuid)
Branch Id
-
branchTitle: string
Visit Branch titleExample:
Branch 2 -
endVisitId: string
(uuid)
End visit ID
-
eventType: string
Visit event typeExample:
ScreeningVisit -
fullName: string
Concatenation of Visit Title and Branch title with hypenExample:
B1C01 - V01 -
id: string
(uuid)
Visit GUID
-
lastRequired: boolean
Yes - if Visit is last required.Example:
false -
randomization: string
(uuid)
Randomization GUID
-
repeatNumber(required): integer
(int32)
Times to repeat Visit Design.Example:
5 -
repeatVisit(required): boolean
Yes - if Visit Design is repeating.Example:
false -
requiredVisit(required): boolean
Yes - if Visit Design is required.Example:
false -
shortName(required): string
Minimum Length:
1Maximum Length:16Pattern:[a-zA-Z0-9]+Visit short nameExample:Week1 -
startVisitId: string
(uuid)
Start visit ID
-
studyVersion: string
Study versionExample:
1.0.0.1 -
studyVersionStatus: string
Study version statusExample:
TESTING -
timeLine: integer
(int32)
show in timeline. allows the designer to set when a visit can be shown to a user.Example:
1 -
title(required): string
Minimum Length:
1Maximum Length:64Visit titleExample:Week 2 -
visitDescription: string
Visit descriptionExample:
Regular 2 week visit -
visitStartDate: string
(date-time)
Visit start date timeExample:
2019-01-25T07:42:00.204Z
500 Response
Error
Nested Schema : details
Type:
object