Jump to

• Request
• Response

V3.0

get

/ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}

Retrieves the list of subject transfer records based on the subject ID.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  active

• studyId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  CDBBCCDDEEFF11223344556677889900

• subjectId(required): string(uuid)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SubjectTransferDto3
  Represents a subject transfer between sites used for API rresponse bodies including version end.

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

Nested Schema : SubjectTransferDto3

Type: object

Represents a subject transfer between sites used for API rresponse bodies including version end.

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Additional comment or note about the subject transfer.

  Example: Moved subject to new site
• 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
  Minimum Length: 0

  Maximum Length: 500

  New subject number after transfer or renumbering.

  Example: SUBJ-0001-NEW
• objectVersionNumber: number
  Object version number

  Example: 1
• operationType: string
  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: CREATED
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for the subject transfer.

  Example: Site change
• softwareVersionNumber: number
  Software version number

  Example: 8
• subjectId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the subject being transferred.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• subjectNumber: string
  Minimum Length: 0

  Maximum Length: 500

  Unique subject Number representing the patient/participant enrolled in the study.

  Example: SUBJ-0001
• toSiteId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site the subject is transferred to.

  Example: 699EF3745FC545589F186D2198F3C65E
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.

  Example: 3099-12-31T00:00:00Z
• versionStart: string (date-time)
  Timestamp representing the start of the version for this subject transfer 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 being transferred.",
            "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 subject transfer.",
            "example":"Site change"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment or note about the subject transfer.",
            "example":"Moved subject to new site"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"CREATED"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number",
            "example":1
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number",
            "example":8
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time",
            "example":"3099-12-31T00:00:00Z"
        },
        "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 subject transfer record.",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Unique subject Number representing the patient/participant enrolled in the study.",
            "example":"SUBJ-0001"
        },
        "newSubjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"New subject number after transfer or renumbering.",
            "example":"SUBJ-0001-NEW"
        }
    },
    "description":"Represents a subject transfer between sites used for API rresponse bodies including version end."
}

Examples

Select an example SubjectTransfersBySubjectIdResponse

400 Response

Bad request.

Body ()

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

Back to Top