REST API for Clinical One Platform

Get transfer records for a subject and date range

get

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjecttransfers/dateRange/{subjectId}

Retrieves all the transfers for a subject that happened in a specific date range. Used by Integration Hub.
Rights: DataCaptureSubjectIntegrationGet and SubjectDataClassificationGet.

Request

Path Parameters

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 : RestResponse

Type: object

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object