Jump to

• Request
• Response

[Deprecated]: V1.0

get

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

Deprecated: Use latest version instead. Deprecated in v1.0. Returns form and item summaries by mode. Use /v2.0/studies/{studyId}/{mode}/forms/formitems or /v20.0 forms APIs for newer contracts.

Request

Path Parameters

• mode(required): string
  Study mode path segment. Required. Allowed values: test, training, active.
• studyId(required): string
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.
• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Form and item summaries returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

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

  Summary information for a study form returned by the V1.0 query forms API.

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

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

• id: string (uuid)
  Form ID. UUID, 32-character uppercase hexadecimal string.
• items: array items
  Form item summaries.
• refname: string
  Reference name for the form.

  Example: DEMOGRAPHICS
• title: string
  Display title for the form.

  Example: Demographics

{
    "title":"FormSummaryDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form ID. UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Reference name for the form.",
            "example":"DEMOGRAPHICS"
        },
        "title":{
            "type":"string",
            "description":"Display title for the form.",
            "example":"Demographics"
        },
        "items":{
            "type":"array",
            "description":"Form item summaries.",
            "example":[
                {
                    "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
                    "refname":"AGE",
                    "questionType":"numeric",
                    "questionLabel":"Age"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemSummaryDtoV1"
            }
        }
    },
    "description":"Summary information for a study form returned by the V1.0 query forms API.",
    "example":{
        "id":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
        "refname":"DEMOGRAPHICS",
        "title":"Demographics",
        "items":[
            {
                "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
                "refname":"AGE",
                "questionType":"numeric",
                "questionLabel":"Age"
            }
        ]
    }
}

Example:

{
    "id":"2F9A6C7E1B8F4D56A23C9F3A0C7D4E11",
    "refname":"DEMOGRAPHICS",
    "title":"Demographics",
    "items":[
        {
            "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
            "refname":"AGE",
            "questionType":"numeric",
            "questionLabel":"Age"
        }
    ]
}

Nested Schema : items

Type: array

Form item summaries.

Show Source

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

  Summary information for a form item returned by the V1.0 query forms API.

{
    "type":"array",
    "description":"Form item summaries.",
    "example":[
        {
            "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
            "refname":"AGE",
            "questionType":"numeric",
            "questionLabel":"Age"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemSummaryDtoV1"
    }
}

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

• id: string (uuid)
  Form item ID. UUID, 32-character uppercase hexadecimal string.
• questionLabel: string
  Display label for the question.

  Example: Age
• questionType: string
  Title: FormItemType

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

  Question type for the form item.

  Example: numeric
• refname: string
  Reference name for the form item.

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

  IDs of sub-items for a question group. Each ID is a UUID, 32-character uppercase hexadecimal string.

{
    "title":"FormItemSummaryDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form item ID. UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Reference name for the form item.",
            "example":"AGE"
        },
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type for the form item.",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "questionLabel":{
            "type":"string",
            "description":"Display label for the question.",
            "example":"Age"
        },
        "subItemIds":{
            "title":"Sub item ids",
            "type":"string",
            "description":"IDs of sub-items for a question group. Each ID is a UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        }
    },
    "description":"Summary information for a form item returned by the V1.0 query forms API.",
    "example":{
        "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
        "refname":"AGE",
        "questionType":"numeric",
        "questionLabel":"Age"
    }
}

Example:

{
    "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
    "refname":"AGE",
    "questionType":"numeric",
    "questionLabel":"Age"
}

Examples

Select an example formItemsSummaryResponseV1

500 Response

Error

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top