Jump to

• Request
• Response

v1.0

get

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

The API endpoint is designed to fetch all subject transfers for a given study, as indicated by the studyId path parameter.

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:

  A1B2C3D4E5F647839ABCDEF012345678

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 SubjectNumberTransferDto

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

Nested Schema : SubjectNumberTransferDto

Type: object

Show Source

• comment: string
  Additional comment or note about the transfer.

  Example: Automated renumber after transfer
• 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 number transfer record.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• newSubjectNumber: string
  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: MODIFIED
• randNumber: string
  Randomization number assigned to the subject if applicable.

  Example: R-000123
• reason: string
  Reason for the subject number transfer.

  Example: Site change
• softwareVersionNumber: number
  Software version number used when the record was generated.

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

  Example: 42CE52A1AF9A48EBABA25A361F6EC0FE
• subjectNumber: string
  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
• userId: string
  Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user

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

  Example: 2023-01-01T10:00:00Z
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the subject number transfer record.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"42CE52A1AF9A48EBABA25A361F6EC0FE"
        },
        "subjectNumber":{
            "type":"string",
            "description":"Unique subject Number representing the patient/participant enrolled in the study.",
            "example":"SUBJ-0001"
        },
        "newSubjectNumber":{
            "type":"string",
            "description":"New subject number after transfer or renumbering.",
            "example":"SUBJ-0001-NEW"
        },
        "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":{
            "type":"string",
            "description":"Reason for the subject number transfer.",
            "example":"Site change"
        },
        "comment":{
            "type":"string",
            "description":"Additional comment or note about the transfer.",
            "example":"Automated renumber after transfer"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"MODIFIED"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number",
            "example":1
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number used when the record was generated.",
            "example":300
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time",
            "example":"2023-01-01T10:00:00Z"
        },
        "userId":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user",
            "example":"225B79C982104415886DE02BC73C1E1E"
        },
        "randNumber":{
            "type":"string",
            "description":"Randomization number assigned to the subject if applicable.",
            "example":"R-000123"
        }
    }
}

Examples

Select an example SubjectNumberTransfers

400 Response

Bad request.

Body ()

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

Back to Top