[Deprecated]: Add a visit
post
/ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visits
Deprecated: Use latest version instead. Adds 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"
Supported Media Types
- */*
Root Schema : VisitDto v6.0
Type:
object
Title:
VisitDto v6.0
Visit design.
Show Source
-
branchId: string
(uuid)
Branch Id
-
endVisitId: string
(uuid)
End visit ID
-
eventType: string
Visit event typeExample:
ScreeningVisit
-
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:
1
Maximum Length:16
Pattern:[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
-
title(required): string
Minimum Length:
1
Maximum Length:64
Visit 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 v6.0
Title:
VisitDto v6.0
Visit design.
Nested Schema : VisitDto v6.0
Type:
object
Title:
VisitDto v6.0
Visit design.
Show Source
-
branchId: string
(uuid)
Branch Id
-
endVisitId: string
(uuid)
End visit ID
-
eventType: string
Visit event typeExample:
ScreeningVisit
-
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:
1
Maximum Length:16
Pattern:[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
-
title(required): string
Minimum Length:
1
Maximum Length:64
Visit 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