Get a list of study form visits
get
/ec-designer-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/visits
Retrieves a list of form visits in a study.
Request
Path Parameters
-
formId(required): string(uuid)
-
mode(required): string
Study mode to filter study form visits.
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
Query Parameters
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 StudyVisitDto v1.0
Title:
StudyVisitDto v1.0
Reduced Visit and branch properties
Nested Schema : StudyVisitDto v1.0
Type:
object
Title:
StudyVisitDto v1.0
Reduced Visit and branch properties
Show Source
-
branchIsCycle: boolean
The branch is cyclic or acyclicExample:
true
-
branchShortName: string
Visit Branch shortNameExample:
Br1
-
branchTitle: string
Branch titleExample:
Branch1
-
cycleCount: number
number of times a branch can cycleExample:
10
-
eventType: string
Visit event typeExample:
ScreeningVisit
-
fullName: string
Concatenation of Visit Title and Branch title with hypenExample:
B1C01 - V01
-
id: string
(uuid)
Branch GUID
-
shortName: string
Visit shortnameExample:
W2
-
startCycle: integer
(int32)
Start Cycle Number
-
title: string
Visit titleExample:
Week2
500 Response
Error
Nested Schema : details
Type:
object