Jump to

• Request
• Response

V1.0

post

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/subjects/aeCount

Retrieves the list of adverse event visit counts for a given list of subjects.

Request

Path Parameters

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

  Example:

  test

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

  Example:

  E6C7BC17E0F041D5B79B21A165911AC3

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request payload containing a list of subject identifiers.

Show Source

• subjects: array subjects
  List of subject identifiers in UUID, 32-character uppercase hexadecimal string

{
    "type":"object",
    "properties":{
        "subjects":{
            "type":"array",
            "description":"List of subject identifiers in UUID, 32-character uppercase hexadecimal string",
            "example":[
                "1BC29B36F5D64B1B95F4BDBBCEA481BE",
                "2ABC8A2C11045A584ADEA8760F72B114"
            ],
            "items":{
                "type":"string",
                "description":"List of subject identifiers in UUID, 32-character uppercase hexadecimal string",
                "format":"uuid"
            }
        }
    },
    "description":"Request payload containing a list of subject identifiers."
}

Nested Schema : subjects

Type: array

List of subject identifiers in UUID, 32-character uppercase hexadecimal string

Show Source

• Array of: string(uuid)
  List of subject identifiers in UUID, 32-character uppercase hexadecimal string

{
    "type":"array",
    "description":"List of subject identifiers in UUID, 32-character uppercase hexadecimal string",
    "example":[
        "1BC29B36F5D64B1B95F4BDBBCEA481BE",
        "2ABC8A2C11045A584ADEA8760F72B114"
    ],
    "items":{
        "type":"string",
        "description":"List of subject identifiers in UUID, 32-character uppercase hexadecimal string",
        "format":"uuid"
    }
}

Example:

[
    "1BC29B36F5D64B1B95F4BDBBCEA481BE",
    "2ABC8A2C11045A584ADEA8760F72B114"
]

Examples

Select an example SubjectVisitsReqExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects success.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SubjectAECountDto
  Adverse event count details per subject and event in a given study version.

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

Nested Schema : SubjectAECountDto

Type: object

Adverse event count details per subject and event in a given study version.

Show Source

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

  Example: 53915DD9B758466AB2226CBCC4466B7E
• repeatingFormCount: number
  Number of repeating form instances for the visit.

  Example: 2
• studyVersion: 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: string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"53915DD9B758466AB2226CBCC4466B7E"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "repeatingFormCount":{
            "type":"number",
            "description":"Number of repeating form instances for the visit.",
            "example":2
        }
    },
    "description":"Adverse event count details per subject and event in a given study version."
}

Examples

Select an example SubjectAECountDtoListExample

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