REST API for Clinical One Platform

~~[Deprecated]: Get a list of subjects for the specified study and mode~~

get

/ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/history/all

Deprecated: Lists all subjects for the specified study and mode with sourceTimeStamp value in response. It only returns subjects for the sites to which the requesting user has access and details described in the Response section for each subject. Rights: DataCaptureSubjectGet and SubjectDataClassificationGet. API has been deprecated and moved to DIS (Data Integration Service), Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/history/all

Request

Path Parameters

mode(required): string

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

ID of the study for which you want to get the list of subjects.

Query Parameters

limit(required): integer(int32)

Minimum Value: 0

Number of subjects.
offset(required): integer(int32)

Starting offset.
siteId(required): string(uuid)

Site ID.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object SubjectDto9

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

Nested Schema : SubjectDto9

Type: object

Show Source

codeBreak: string
comment: string

Minimum Length: 0

Maximum Length: 2048
description: string

Minimum Length: 0

Maximum Length: 500
dob: string (date-time)
enrollmentFailure: string

Minimum Length: 0

Maximum Length: 255
enrollmentOverride: string

Minimum Length: 0

Maximum Length: 255
eventType: string
freezedStatus: string
fromStudyId: string (uuid)
gender: string

Minimum Length: 0

Maximum Length: 10
id: string (uuid)
informedConsentDate: string (date-time)
lastSigned: string
mhealthSubjectId: string (uuid)
objectVersionNumber: number
operationType: string
previousSubjectNumber: string
reason: string

Minimum Length: 0

Maximum Length: 255
screeningDate: string (date-time)
screeningFailure: string

Minimum Length: 0

Maximum Length: 255
signedStatus: string
siteId: string
softwareVersionNumber: number
sourceTimeStamp: string (date-time)
state(required): string

Minimum Length: 0

Maximum Length: 100
stateDate: string (date-time)
studyId: string
studyVersion(required): string
subjectNumber(required): string

Minimum Length: 0

Maximum Length: 500
subjectSiteSerialNumber: string
subjectStudySerialNumber: string
subjectTransferId: string (uuid)
subjNumSiteOrgId: string
userId: string (uuid)
verifiedStatus: string
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "required":[
        "state",
        "studyVersion",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "screeningDate":{
            "type":"string",
            "format":"date-time"
        },
        "codeBreak":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "eventType":{
            "type":"string"
        },
        "subjectTransferId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "mhealthSubjectId":{
            "type":"string",
            "format":"uuid"
        },
        "fromStudyId":{
            "type":"string",
            "format":"uuid"
        },
        "subjNumSiteOrgId":{
            "type":"string"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "lastSigned":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "operationType":{
            "type":"string"
        },
        "subjectStudySerialNumber":{
            "type":"string"
        },
        "subjectSiteSerialNumber":{
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "previousSubjectNumber":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "description":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        },
        "subjectNumber":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "dob":{
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "stateDate":{
            "type":"string",
            "format":"date-time"
        },
        "screeningFailure":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "enrollmentFailure":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "enrollmentOverride":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "informedConsentDate":{
            "type":"string",
            "format":"date-time"
        },
        "gender":{
            "maxLength":"10",
            "minLength":"0",
            "type":"string"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "sourceTimeStamp":{
            "type":"string",
            "format":"date-time"
        }
    }
}

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData
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

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object