1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Designer
  4. Form APIs
  5. Form
  6. Get form visit summary

[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
Query Parameters
  • Form item type to exclude from returned form item details.
    Allowed Values: [ "instructionalText" ]
    Example:
    instructionalText
  • Form category filter.
    Default Value: ALL
    Allowed Values: [ "DCS", "NSF", "ALL" ]
    Example:
    ALL
  • Include form details in the response.
    Default Value: true
    Example:
    true
  • Study mode filter.
    Allowed Values: [ "test", "training", "active" ]
    Example:
    test
  • Include visit details in the response.
    Default Value: true
    Example:
    true

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Visits and forms summary was returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : RespVisitsFormsSummaryDto
Type: object
Show Source
Nested Schema : FormSummaryDto v1.0
Type: object
Title: FormSummaryDto v1.0
Summary information for a study form returned by the V1.0 query forms API.
Show Source
Example:
{
    "id":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "refname":"DEMOGRAPHICS",
    "title":"Demographics",
    "items":[
        {
            "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
            "refname":"AGE",
            "questionType":"numeric",
            "questionLabel":"Age"
        }
    ]
}
Nested Schema : VisitSummaryWithFormIdsDto v1.0
Type: object
Title: VisitSummaryWithFormIdsDto v1.0
Reduced Visit and branch properties
Show Source
Nested Schema : items
Type: array
Form item summaries.
Show Source
Example:
[
    {
        "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
        "refname":"AGE",
        "questionType":"numeric",
        "questionLabel":"Age"
    }
]
Nested Schema : FormItemSummaryDto v1.0
Type: object
Title: FormItemSummaryDto v1.0
Summary information for a form item returned by the V1.0 query forms API.
Show Source
  • Form item ID. UUID, 32-character uppercase hexadecimal string.
  • Display label for the question.
    Example: Age
  • Title: FormItemType
    Allowed Values: [ "text", "instructionalText", "numeric", "datetime", "choice", "questionGroup", "table", "label", "section", "existingData", "fileUpload" ]
    Question type for the form item.
    Example: numeric
  • Reference name for the form item.
    Example: AGE
  • Title: Sub item ids
    IDs of sub-items for a question group. Each ID is a UUID, 32-character uppercase hexadecimal string.
Example:
{
    "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
    "refname":"AGE",
    "questionType":"numeric",
    "questionLabel":"Age"
}
Nested Schema : formIds
Type: array
List of visit forms IDs
Show Source
Example:
[
    "938D23FA6B7241CCA41BD627E5DB60DA",
    "699EF3745FC545589F186D2198F3C65E"
]
Examples

400 Response

The request payload is missing studyVersion or visitId, or contains invalid values.
Body ()
Root Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • 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
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Examples

500 Response

Error
Body ()
Root Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • 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
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Examples

Back to Top