Jump to

• Request
• Response

V1.0

get

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/forms/studyVersion/{studyVersion}/subject/{subjectId}/event/{eventId}

Retrieves the Associated and Dynamic forms for a subject visit.

Request

Path Parameters

• eventId(required): string(uuid)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example:

  53915DD9B758466AB2226CBCC4466B7E

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  E6C7BC17E0F041D5B79B21A165911AC3

• studyVersion(required): string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example:

  3.0.0.1

• subjectId(required): string(uuid)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example:

  B5969AC2FBA840438F9E0DB26A2DD33E

Query Parameters

• eventInstanceNum(required): string
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects success.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object VisitDynamicAssoFormsResponse
  Response object describing dynamic or associated form visibility for a given visit.

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

Nested Schema : VisitDynamicAssoFormsResponse

Type: object

Response object describing dynamic or associated form visibility for a given visit.

Show Source

• formId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: ABCDEF1234567890ABCDEF1234567890
• formType: integer (int32)
  Form type indicator where 0 represents ASSOCIATED_FORM and 1 represents DYNAMIC_FORM

  Example: 0
• isVisible: boolean
  Flag indicating if the form should be visible on the visit for the subject

  Example: true

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "isVisible":{
            "type":"boolean",
            "description":"Flag indicating if the form should be visible on the visit for the subject",
            "example":true
        },
        "formType":{
            "type":"integer",
            "description":"Form type indicator where 0 represents ASSOCIATED_FORM and 1 represents DYNAMIC_FORM",
            "format":"int32",
            "example":0
        }
    },
    "description":"Response object describing dynamic or associated form visibility for a given visit."
}

Examples

Select an example VisitDynamicAssoFormsResponseListExample

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top