Jump to

• Request
• Response

Get visit summary with form and item IDs

post

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

Retrieves visit summary with form and item IDs.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

• excludeItemType: string
  Form Item type to exclude from response

  Allowed Values: [ "instructionalText" ]
• formCategory: string
  Return forms with this Form Category.

  Default Value: ALL

  Allowed Values: [ "DCS", "NSF", "ALL" ]
• forms: boolean
  Include froms in response

  Default Value: true
• items: string
  Default Value: all
• mode(required): string
  Study mode to filter study forms.

  Allowed Values: [ "test", "training", "active" ]
• visits: boolean
  Include visits in response

  Default Value: true

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: array

Show Source

• Array of: object StudyVersionVisitDtoV9

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

Nested Schema : StudyVersionVisitDtoV9

Type: object

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

{
    "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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

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/Form Summary DTO V1"
            }
        }
    }
}

Nested Schema : forms

Type: array

Show Source

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

  Reduced form properties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Form Summary DTO V1"
    }
}

Nested Schema : visits

Type: array

Show Source

• Array of: object VisitSummaryWithFormIdsDto

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

Nested Schema : FormSummaryDto v1.0

Type: object

Title: FormSummaryDto v1.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 v1.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/Form Item Summary DTO V1"
            }
        }
    },
    "description":"Reduced form properties"
}

Nested Schema : items

Type: array

Show Source

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

  Reduced form item properties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Form Item Summary DTO V1"
    }
}

Nested Schema : FormItemSummaryDto v1.0

Type: object

Title: FormItemSummaryDto v1.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" ]

  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 v1.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"
            ]
        },
        "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
• shortName(required): string
• studyVersion(required): string
• title(required): string
• visitSeq: integer (int32)

{
    "required":[
        "branchCycleCount",
        "branchStartCycle",
        "isDispensed",
        "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"
        },
        "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"
    }
}

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