Jump to

• Request
• Response

[Deprecated]: v1.0

post

/ec-designer-edc-svc/rest/v1.0/studies/{studyId}/visitsforms/formitems

Deprecated: Use latest version instead. Returns visit and form summary details for the requested study-version visits. The request body is an array where each object identifies a study version and visit. The response is an EDC envelope whose result contains visit summaries and form summaries for the requested visits. This API is no longer supported

Request

Path Parameters

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

Query Parameters

• excludeItemType: string
  Form item type to exclude (optional). Allowed value: instructionalText.

  Allowed Values: [ "instructionalText" ]
• formCategory: string
  Form category filter (optional). Allowed values: DCS, NSF, ALL.

  Default Value: ALL

  Allowed Values: [ "DCS", "NSF", "ALL" ]
• forms: boolean
  Include form details in response (optional). Allowed values: true, false.

  Default Value: true
• mode(required): string
  Study mode filter. Required. Allowed values: test, training, active.

  Allowed Values: [ "test", "training", "active" ]
• visits: boolean
  Include visit details in response (optional). Allowed values: true, false.

  Default Value: true

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

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

  Information about a visit in a study version.

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

Nested Schema : StudyVersionVisitDto v9.0

Type: object

Title: StudyVersionVisitDto v9.0

Information about a visit in a study version.

Show Source

• studyId: string (uuid)
• studyTitle: string
  Study name

  Example: Study 03
• version: string
  version

  Example: 1.3.0.6
• versionPreviousStatus: string
  Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

  Previous study status

  Example: TESTING
• versionStatus: string
  Study version status

  Example: Active, not recruiting
• visitId: string (uuid)
  Visit GUID

{
    "title":"StudyVersionVisitDto v9.0",
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "version":{
            "type":"string",
            "description":"version",
            "example":"1.3.0.6"
        },
        "studyTitle":{
            "type":"string",
            "description":"Study name",
            "example":"Study 03"
        },
        "versionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"Active, not recruiting"
        },
        "versionPreviousStatus":{
            "type":"string",
            "description":"Previous study status",
            "example":"TESTING",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        }
    },
    "description":"Information about a visit in a study version."
}

Examples

Select an example visitsFormsSummaryRequestV1

Back to Top

Response

Supported Media Types

• application/json

200 Response

Visits and forms summary returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object VisitsFormsSummaryDto

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

Nested Schema : VisitsFormsSummaryDto

Type: object

Show Source

• forms: array forms
• studyVersion: string
• visits: array visits

{
    "type":"object",
    "properties":{
        "studyVersion":{
            "type":"string"
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitSummaryWithFormIdsDto"
            }
        },
        "forms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormSummaryFlatDtoV2"
            }
        }
    }
}

Nested Schema : forms

Type: array

Show Source

• Array of: object FormSummaryDto v2.0
  Title: FormSummaryDto v2.0

  Reduced form properties

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

Nested Schema : visits

Type: array

Show Source

• Array of: object VisitSummaryWithFormIdsDto

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

Nested Schema : FormSummaryDto v2.0

Type: object

Title: FormSummaryDto v2.0

Reduced form properties

Show Source

• id: string (uuid)
  Form Unique GUID
• items: array items
• refname: string
  Form refname

  Example: FORM_01
• title: string
  Form title

  Example: Demography

{
    "title":"FormSummaryDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Form refname",
            "example":"FORM_01"
        },
        "title":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemSummaryDTOV2"
            }
        }
    },
    "description":"Reduced form properties"
}

Nested Schema : items

Type: array

Show Source

• Array of: object FormItemSummaryDto v2.0
  Title: FormItemSummaryDto v2.0

  Reduced form item properties

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

Nested Schema : FormItemSummaryDto v2.0

Type: object

Title: FormItemSummaryDto v2.0

Reduced form item properties

Show Source

• id: string (uuid)
  Form Item Unique GUID
• questionLabel: string
  Form question label

  Example: Age
• questionType: string
  Title: FormItemType

  Allowed Values: [ "text", "instructionalText", "numeric", "datetime", "choice", "questionGroup", "table", "label", "section", "existingData", "fileUpload" ]

  Question type

  Example: numeric
• refname: string
  Form item reference name.

  Example: NUMBER_01
• subItemIds: string (uuid)
  Title: Sub item ids

  List of sub question ids

{
    "title":"FormItemSummaryDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form Item Unique GUID",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "questionLabel":{
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "subItemIds":{
            "title":"Sub item ids",
            "type":"string",
            "description":"List of sub question ids",
            "format":"uuid"
        }
    },
    "description":"Reduced form item properties"
}

Nested Schema : VisitSummaryWithFormIdsDto

Type: object

Show Source

• branchCycleCount(required): number
• branchId: string (uuid)
• branchIndex: integer (int32)
• branchIsCycle: boolean
• branchShortName: string
• branchStartCycle(required): integer (int32)
• branchTier: integer (int32)
• branchTitle: string
• eventType: string
• formIds: array formIds
• fullName: string
• id: string (uuid)
• isDispensed(required): boolean
• sdvRequired(required): string
  Allowed Values: [ "NOTSET", "NEVER", "ALWAYS", "CRITICAL" ]
• shortName(required): string
• studyVersion(required): string
• title(required): string
• visitSeq: integer (int32)

{
    "required":[
        "branchCycleCount",
        "branchStartCycle",
        "isDispensed",
        "sdvRequired",
        "shortName",
        "studyVersion",
        "title"
    ],
    "type":"object",
    "properties":{
        "visitSeq":{
            "type":"integer",
            "format":"int32"
        },
        "branchTier":{
            "type":"integer",
            "format":"int32"
        },
        "branchIndex":{
            "type":"integer",
            "format":"int32"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "title":{
            "type":"string"
        },
        "shortName":{
            "type":"string"
        },
        "fullName":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "branchId":{
            "type":"string",
            "format":"uuid"
        },
        "branchTitle":{
            "type":"string"
        },
        "branchShortName":{
            "type":"string"
        },
        "branchIsCycle":{
            "type":"boolean"
        },
        "branchStartCycle":{
            "type":"integer",
            "format":"int32"
        },
        "branchCycleCount":{
            "type":"number"
        },
        "isDispensed":{
            "type":"boolean"
        },
        "studyVersion":{
            "type":"string"
        },
        "sdvRequired":{
            "type":"string",
            "enum":[
                "NOTSET",
                "NEVER",
                "ALWAYS",
                "CRITICAL"
            ]
        },
        "formIds":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : formIds

Type: array

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Examples

Select an example visitsFormsSummaryResponseV1

500 Response

Error

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Back to Top