REST API for Clinical One Platform

Get Subject count

get

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

Get count of all active subjects available in the Study

Request

Path Parameters

mode(required): string

Mode of the study. Accepts test, active, or training.
studyId(required): string

ID of the study to which the subject belongs.

Query Parameters

siteId(required): string(uuid)

Site ID.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Subjects success.

Root Schema : schema

Type: array

Show Source

Array of: object SubjectCountResponseDto20

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

Nested Schema : SubjectCountResponseDto20

Type: object

Show Source

activeSubjects: integer (int32)
completedSubjects: integer (int32)
enrolledSubjects: integer (int32)
newSubjects: integer (int32)
screendSubjects: integer (int32)
screenFailedSubjects: integer (int32)
siteSummary: array siteSummary
totalSubjects: integer (int32)
withdrwanSubjects: integer (int32)

{
    "type":"object",
    "properties":{
        "totalSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "newSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "activeSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "withdrwanSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "enrolledSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "screendSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "screenFailedSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "completedSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "siteSummary":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubjectCountBySiteResponseDto"
            }
        }
    }
}

Nested Schema : siteSummary

Type: array

Show Source

Array of: object SubjectCountBySiteResponseDto

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

Nested Schema : SubjectCountBySiteResponseDto

Type: object

Show Source

activeSubjects: integer (int32)
completedSubjects: integer (int32)
enrolledSubjects: integer (int32)
newSubjects: integer (int32)
screendSubjects: integer (int32)
screenFailedSubjects: integer (int32)
siteId: string
totalSubjects: integer (int32)
withdrwanSubjects: integer (int32)

{
    "type":"object",
    "properties":{
        "siteId":{
            "type":"string"
        },
        "totalSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "newSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "activeSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "withdrwanSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "enrolledSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "screendSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "screenFailedSubjects":{
            "type":"integer",
            "format":"int32"
        },
        "completedSubjects":{
            "type":"integer",
            "format":"int32"
        }
    }
}

400 Response

Bad request.

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.