Jump to

• Request
• Response

V10.0

get

/ec-designer-svc/rest/v10.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)
  Form ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  F054C951EB74443C93716CA714AB686E

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

Query Parameters

• mode(required): string
  Study mode for data classifications. Allowed values: design (draft design data), test (testing data), training (training data), active (approved production data), all (all modes).

  Default Value: design

  Allowed Values: [ "test", "training", "active", "design" ]

  Example:

  design

• response: string
  Response type to query visit forms Optional.

  Default Value:

  Allowed Values: [ "", "summary", "summaryLite" ]

  Example:

  summary

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object FormVisitDto v9.0
  Title: FormVisitDto v9.0

  Form Visits Information

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormVisitDtoV9"
    }
}

Nested Schema : FormVisitDto v9.0

Type: object

Title: FormVisitDto v9.0

Form Visits Information

Show Source

• forms: array forms
  List of forms
• id: string (uuid)
  Visit GUID

{
    "title":"FormVisitDto v9.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "forms":{
            "type":"array",
            "description":"List of forms",
            "items":{
                "$ref":"#/components/schemas/VisitFormDtoV9"
            }
        }
    },
    "description":"Form Visits Information"
}

Nested Schema : forms

Type: array

List of forms

Show Source

• Array of: object VisitFormDto v9.0
  Title: VisitFormDto v9.0

  Visit design forms.

{
    "type":"array",
    "description":"List of forms",
    "items":{
        "$ref":"#/components/schemas/VisitFormDtoV9"
    }
}

Nested Schema : VisitFormDto v9.0

Type: object

Title: VisitFormDto v9.0

Visit design forms.

Show Source

• fields: integer (int32)
  Number of form's fields

  Example: 5
• formId: string (uuid)
  Visit Design form GUID
• formRefName: string
  Form RefName

  Example: Demography
• formTitle: string
  Form title

  Example: Demography

{
    "title":"VisitFormDto v9.0",
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Visit Design form GUID",
            "format":"uuid"
        },
        "formTitle":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "formRefName":{
            "type":"string",
            "description":"Form RefName",
            "example":"Demography"
        },
        "fields":{
            "type":"integer",
            "description":"Number of form's fields",
            "format":"int32",
            "example":5
        }
    },
    "description":"Visit design forms."
}

Examples

Select an example getVisitsV10Response

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top