Get visits associated with a form
get
/ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Retrieves visits associated with a specific form in a study.
Request
Path Parameters
-
formId(required): string(uuid)
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
-
version(required): string
Study version. Example: "1.0.0.1"
Query Parameters
-
items: string
-
mode(required): string
Study version mode for Data Classifications.Default Value:
design
Allowed Values:[ "test", "training", "active", "design" ]
-
response: string
Response type to query visit formsDefault Value:Allowed Values:
[ "", "summary", "summaryLite" ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Nested Schema : FormVisitDtoV9
Type:
Show Source
object
-
forms: array
forms
List of forms
-
id: string
(uuid)
Visit GUID
Nested Schema : forms
Type:
array
List of forms
Show Source
-
Array of:
object VisitFormDto v9.0
Title:
VisitFormDto v9.0
Visit design forms.
Nested Schema : VisitFormDto v9.0
Type:
object
Title:
VisitFormDto v9.0
Visit design forms.
Show Source
-
fields: integer
(int32)
Number of form's fieldsExample:
5
-
formId: string
(uuid)
Visit Design form GUID
-
formRefName: string
Form RefNameExample:
Demography
-
formTitle: string
Form titleExample:
Demography
500 Response
Error
Nested Schema : details
Type:
object