REST API for Clinical One Platform

~~[Deprecated]: Get transfer records for a subject for a date range~~

get

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/dateRange/{subjectId}

Deprecated: Retrieves all the transfers for a subject that happened in a specific date range. Used by Integration Hub. Rights: DataCaptureSubjectIntegrationGet and SubjectDataClassificationGet. API has been deprecated and moved to DIS (Data Integration Service), Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjecttransfers/dateRange/{subjectId}

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.
subjectId(required): string(uuid)

ID of the subject for whom you want to retrieve transfer details.

Query Parameters

endDate(required): string(date-time)

The ending date and time (optional) for which you want to get events. If you don't specify the time, the date range stops before midnight (23:59:59 UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, dd-MMM-yyyy HH:mm, or dd-MMM-yyyy.
startDate(required): string(date-time)

The starting date and time (optional) for which you want to get events. If you don't specify the time, the date range begins after midnight (UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, dd-MMM-yyyy HH:mm, or dd-MMM-yyyy.

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 SubjectTransfer

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

Nested Schema : SubjectTransfer

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
fromSiteId: string
id: string (uuid)
newSubjectNumber: string
operationType: string

Minimum Length: 1

Maximum Length: 16
randomizationNumber: string
reason: string

Minimum Length: 0

Maximum Length: 255
subjectId: string
subjectNumber: string

Minimum Length: 0

Maximum Length: 500
toSiteId: string
userId: string (uuid)
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string"
        },
        "fromSiteId":{
            "type":"string"
        },
        "toSiteId":{
            "type":"string"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string"
        },
        "newSubjectNumber":{
            "type":"string"
        },
        "randomizationNumber":{
            "type":"string"
        }
    }
}

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.