Jump to

• Request
• Response

V1.0

get

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/count

Retrieve the subject count summary for a study. Includes totals for new, active, withdrawn, enrolled, screened, failed, completed 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
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  ABCDEF1234567890ABCDEF1234567890

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subject count summary successfully retrieved.

Body ()

Root Schema : SubjectCountResponseDto

Type: object

Aggregate subject counts summary (total, active, withdrawn, enrolled, screened, failed, completed, new)

Show Source

• activeSubjects: integer (int32)
  Number of currently active subjects

  Example: 160
• completedSubjects: integer (int32)
  Number of subjects who completed the study

  Example: 23
• enrolledSubjects: integer (int32)
  Number of subjects who have been enrolled

  Example: 89
• newSubjects: integer (int32)
  Number of newly added subjects

  Example: 12
• screendSubjects: integer (int32)
  Number of subjects who have been screened

  Example: 180
• screenFailedSubjects: integer (int32)
  Number of subjects who failed screening

  Example: 4
• totalSubjects: integer (int32)
  Total number of subjects

  Example: 200
• withdrwanSubjects: integer (int32)
  Number of subjects withdrawn from the study

  Example: 5

{
    "type":"object",
    "properties":{
        "totalSubjects":{
            "type":"integer",
            "description":"Total number of subjects",
            "format":"int32",
            "example":200
        },
        "newSubjects":{
            "type":"integer",
            "description":"Number of newly added subjects",
            "format":"int32",
            "example":12
        },
        "activeSubjects":{
            "type":"integer",
            "description":"Number of currently active subjects",
            "format":"int32",
            "example":160
        },
        "withdrwanSubjects":{
            "type":"integer",
            "description":"Number of subjects withdrawn from the study",
            "format":"int32",
            "example":5
        },
        "enrolledSubjects":{
            "type":"integer",
            "description":"Number of subjects who have been enrolled",
            "format":"int32",
            "example":89
        },
        "screendSubjects":{
            "type":"integer",
            "description":"Number of subjects who have been screened",
            "format":"int32",
            "example":180
        },
        "screenFailedSubjects":{
            "type":"integer",
            "description":"Number of subjects who failed screening",
            "format":"int32",
            "example":4
        },
        "completedSubjects":{
            "type":"integer",
            "description":"Number of subjects who completed the study",
            "format":"int32",
            "example":23
        }
    },
    "description":"Aggregate subject counts summary (total, active, withdrawn, enrolled, screened, failed, completed, new)"
}

Examples

Select an example Subject Count Response

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