Jump to

• Request
• Response

V2.0

get

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

Returns the number of subjects in the study for the given mode and site. Use this to quickly retrieve subject population statistics per site (including summary information).

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  active

• studyId(required): string
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Query Parameters

• siteId(required): string(uuid)
  Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  00AA11BB22CC33DD44EE55FF66GG77HH

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subject count response with summary per site.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SubjectCountResponseDto20
  Subject count summary including total, active, withdrawn, enrolled, screen failed and per-site counts

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

Nested Schema : SubjectCountResponseDto20

Type: object

Subject count summary including total, active, withdrawn, enrolled, screen failed and per-site counts

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
• siteSummary: object siteSummary
  Subject count summary for a single site
• 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
        },
        "siteSummary":{
            "type":"object",
            "properties":{
                "siteId":{
                    "type":"string",
                    "description":"Site unique identifier (UUID, 32-character uppercase hex)",
                    "example":"AABBCCDDEEFF1234567890ABCDEF1234"
                },
                "totalSubjects":{
                    "type":"integer",
                    "description":"Total number of subjects at this site",
                    "format":"int32",
                    "example":50
                },
                "newSubjects":{
                    "type":"integer",
                    "description":"Number of new subjects at this site",
                    "format":"int32",
                    "example":12
                },
                "activeSubjects":{
                    "type":"integer",
                    "description":"Number of active subjects at this site",
                    "format":"int32",
                    "example":40
                },
                "withdrwanSubjects":{
                    "type":"integer",
                    "description":"Number of withdrawn subjects at this site",
                    "format":"int32",
                    "example":1
                },
                "enrolledSubjects":{
                    "type":"integer",
                    "description":"Number of enrolled subjects at this site",
                    "format":"int32",
                    "example":30
                },
                "screendSubjects":{
                    "type":"integer",
                    "description":"Number of screened subjects at this site",
                    "format":"int32",
                    "example":48
                },
                "screenFailedSubjects":{
                    "type":"integer",
                    "description":"Number of subjects who failed screening at this site",
                    "format":"int32",
                    "example":1
                },
                "completedSubjects":{
                    "type":"integer",
                    "description":"Number of completed subjects at this site",
                    "format":"int32",
                    "example":4
                }
            },
            "description":"Subject count summary for a single site"
        }
    },
    "description":"Subject count summary including total, active, withdrawn, enrolled, screen failed and per-site counts"
}

Nested Schema : siteSummary

Type: object

Subject count summary for a single site

Show Source

• activeSubjects: integer (int32)
  Number of active subjects at this site

  Example: 40
• completedSubjects: integer (int32)
  Number of completed subjects at this site

  Example: 4
• enrolledSubjects: integer (int32)
  Number of enrolled subjects at this site

  Example: 30
• newSubjects: integer (int32)
  Number of new subjects at this site

  Example: 12
• screendSubjects: integer (int32)
  Number of screened subjects at this site

  Example: 48
• screenFailedSubjects: integer (int32)
  Number of subjects who failed screening at this site

  Example: 1
• siteId: string
  Site unique identifier (UUID, 32-character uppercase hex)

  Example: AABBCCDDEEFF1234567890ABCDEF1234
• totalSubjects: integer (int32)
  Total number of subjects at this site

  Example: 50
• withdrwanSubjects: integer (int32)
  Number of withdrawn subjects at this site

  Example: 1

{
    "type":"object",
    "properties":{
        "siteId":{
            "type":"string",
            "description":"Site unique identifier (UUID, 32-character uppercase hex)",
            "example":"AABBCCDDEEFF1234567890ABCDEF1234"
        },
        "totalSubjects":{
            "type":"integer",
            "description":"Total number of subjects at this site",
            "format":"int32",
            "example":50
        },
        "newSubjects":{
            "type":"integer",
            "description":"Number of new subjects at this site",
            "format":"int32",
            "example":12
        },
        "activeSubjects":{
            "type":"integer",
            "description":"Number of active subjects at this site",
            "format":"int32",
            "example":40
        },
        "withdrwanSubjects":{
            "type":"integer",
            "description":"Number of withdrawn subjects at this site",
            "format":"int32",
            "example":1
        },
        "enrolledSubjects":{
            "type":"integer",
            "description":"Number of enrolled subjects at this site",
            "format":"int32",
            "example":30
        },
        "screendSubjects":{
            "type":"integer",
            "description":"Number of screened subjects at this site",
            "format":"int32",
            "example":48
        },
        "screenFailedSubjects":{
            "type":"integer",
            "description":"Number of subjects who failed screening at this site",
            "format":"int32",
            "example":1
        },
        "completedSubjects":{
            "type":"integer",
            "description":"Number of completed subjects at this site",
            "format":"int32",
            "example":4
        }
    },
    "description":"Subject count summary for a single site"
}

Examples

Select an example SuccessfulResponse

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