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
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  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) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

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

  Example: 2
• studyVersion: string
  String representing the version of the study. Helps track changes in form or study design.

  Example: 3.0.0.1
• subjectId: string
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"53915DD9B758466AB2226CBCC4466B7E"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study. 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
  Title: ErrorResponseData

  Error Response Details Information
• 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

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top