Jump to

• Request
• Response

Get information for a transfer ID

get

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

Retrieves subject transfer records for the specified transfer ID. Rights: DataCaptureSubjectTransferGet.

Request

Path Parameters

• transferId(required): string
  ID for the transfer details to retrieve.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root 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.

Body ()

Root Schema : RestResponse

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

Back to Top