Jump to

• Request
• Response

V1

post

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers

This endpoint creates a new subject transfer record in the system. Provide all details for a subject transfer in the request body.

Request

Path Parameters

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

  Example:

  test

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

  Example:

  CDBBCCDDEEFF11223344556677889900

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Subject transfer request payload. Contains the subjectTransfer object representing details of a transfer.

Show Source

• subjectTransfer: object SubjectTransferDto
  Represents a subject transfer between sites used for API request/response bodies.

{
    "type":"object",
    "properties":{
        "subjectTransfer":{
            "$ref":"#/components/schemas/SubjectTransferDto"
        }
    },
    "description":"Subject transfer request payload. Contains the subjectTransfer object representing details of a transfer."
}

Nested Schema : SubjectTransferDto

Type: object

Represents a subject transfer between sites used for API request/response bodies.

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
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for the subject transfer.

  Example: Site change
• 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
• 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"
        },
        "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 request/response bodies."
}

Examples

Select an example SubjectTransferRequestDto Example

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : SubjectTransferDto

Type: object

Represents a subject transfer between sites used for API request/response bodies.

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
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for the subject transfer.

  Example: Site change
• 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
• 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"
        },
        "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 request/response bodies."
}

Examples

Select an example SuccessfulResponse

400 Response

Bad request.

Body ()

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

Back to Top