REST API for Clinical One Platform

~~[Deprecated]: V2.0~~

get

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

Deprecated: Retrieves all transfers for a study based on the study mode.
Rights: DataCaptureSubjectTransferGet. API has been deprecated and moved to DIS (Data Integration Service), Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjecttransfers

Request

There are no request parameters for this operation.

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

Represents a subject transfer between sites, including identifiers and audit metadata.

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

Nested Schema : SubjectTransfer

Type: object

Represents a subject transfer between sites, including identifiers and audit metadata.

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048

Comment regarding the last change made to the entity.

Example: Imported via migration tool.
fromSiteId: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site the subject is transferred from.

Example: 938D23FA6B7241CCA41BD627E5DB60DA
id: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the subject transfer record.

Example: A1B2C3D4E5F64789AABBCCDDEEFF1122
newSubjectNumber: string
operationType: string

Minimum Length: 1

Maximum Length: 16

Operation type on the record, can have values CREATED, MODIFIED or REMOVED

Example: REMOVED
randomizationNumber: string

Randomization number associated with the subject, if assigned.

Example: RANDOM123
reason: string

Minimum Length: 0

Maximum Length: 255

Reason for the entity creation or latest modification.

Example: Initial import.
subjectId: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the subject involved in the transfer.

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
subjectNumber: string

Minimum Length: 0

Maximum Length: 500

Subject number before transfer.

Example: SUBJ-0001
toSiteId: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site the subject is transferred to.

Example: 699EF3745FC545589F186D2198F3C65E
versionStart: string (date-time)

Timestamp representing the start of the version for this record.

Example: 2023-01-01T09:00:00Z

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the subject involved in the transfer.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "fromSiteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site the subject is transferred from.",
            "example":"938D23FA6B7241CCA41BD627E5DB60DA"
        },
        "toSiteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site the subject is transferred to.",
            "example":"699EF3745FC545589F186D2198F3C65E"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for the entity creation or latest modification.",
            "example":"Initial import."
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment regarding the last change made to the entity.",
            "example":"Imported via migration tool."
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"REMOVED"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the subject transfer record.",
            "example":"A1B2C3D4E5F64789AABBCCDDEEFF1122"
        },
        "versionStart":{
            "type":"string",
            "description":"Timestamp representing the start of the version for this record.",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Subject number before transfer.",
            "example":"SUBJ-0001"
        },
        "newSubjectNumber":{
            "type":"string"
        },
        "randomizationNumber":{
            "type":"string",
            "description":"Randomization number associated with the subject, if assigned.",
            "example":"RANDOM123"
        }
    },
    "description":"Represents a subject transfer between sites, including identifiers and audit metadata.",
    "example":{
        "id":"A1B2C3D4E5F64789AABBCCDDEEFF1122",
        "versionStart":"2023-01-01T09:00:00Z",
        "subjectId":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
        "subjectNumber":"SUBJ-0001",
        "newSubjectNumber":"SUBJ-0001-NEW",
        "fromSiteId":"938D23FA6B7241CCA41BD627E5DB60DA",
        "toSiteId":"699EF3745FC545589F186D2198F3C65E",
        "randomizationNumber":"RANDOM123",
        "reason":"Site change",
        "comment":"Transferred due to site closure"
    }
}

Example:

{
    "id":"A1B2C3D4E5F64789AABBCCDDEEFF1122",
    "versionStart":"2023-01-01T09:00:00Z",
    "subjectId":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
    "subjectNumber":"SUBJ-0001",
    "newSubjectNumber":"SUBJ-0001-NEW",
    "fromSiteId":"938D23FA6B7241CCA41BD627E5DB60DA",
    "toSiteId":"699EF3745FC545589F186D2198F3C65E",
    "randomizationNumber":"RANDOM123",
    "reason":"Site change",
    "comment":"Transferred due to site closure"
}

400 Response

Bad request.

Root Schema : DcsResponse

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: object details

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
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":"object",
            "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

Nested Schema : details

Type: object

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