Jump to

• Request
• Response

V3.0

post

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

Migrate a subjects details into this study for reconciliation or subject transfer. use v3 with additional payload of randomizationNumber and more information in response.

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:

  3234E620DE2E41D69A36571064E727B2

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• subject: object SubjectMigrationRequestDTO2
  Details for subject migration, including randomization number, subject identifiers, site, status, and timestamps

{
    "type":"object",
    "properties":{
        "subject":{
            "$ref":"#/components/schemas/SubjectMigrationRequestDTO2"
        }
    }
}

Nested Schema : SubjectMigrationRequestDTO2

Type: object

Details for subject migration, including randomization number, subject identifiers, site, status, and timestamps

Show Source

• randomizationNumber: string
  Randomization number for the subject at migration (if present)

  Example: RND-123
• siteId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

  Example: AABBCCDDEEFF1234567890ABCDEF1234
• sourceTimeStamp: string (date-time)
  Timestamp when the migration was triggered/sourced

  Example: 2025-12-01T09:50:00Z
• state(required): string
  Minimum Length: 0

  Maximum Length: 100

  States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed.

  Example: Active
• subjectNumber(required): string
  Minimum Length: 0

  Maximum Length: 500

  External subject number identifier

  Example: SUBJ-0301

{
    "required":[
        "state",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "randomizationNumber":{
            "type":"string",
            "description":"Randomization number for the subject at migration (if present)",
            "example":"RND-123"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"External subject number identifier",
            "example":"SUBJ-0301"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"AABBCCDDEEFF1234567890ABCDEF1234"
        },
        "state":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"States of subjects to filter by Active, New, Screening_Initiated, Enrolled, Complete, Withdrawn, ehrLinked, ehrNotLinked, Screen_Failed, Auto_Screen_Failed.",
            "example":"Active"
        },
        "sourceTimeStamp":{
            "type":"string",
            "description":"Timestamp when the migration was triggered/sourced",
            "format":"date-time",
            "example":"2025-12-01T09:50:00Z"
        }
    },
    "description":"Details for subject migration, including randomization number, subject identifiers, site, status, and timestamps"
}

Examples

Select an example Deep request body for migrating a subject

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : SubjectMigrationResponseDTO2

Type: object

Response payload for subject migration, including audit trail, object/version, subject event and randomization number

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Comment for latest subject update

  Example: Initial enrollment
• description: string
  Minimum Length: 0

  Maximum Length: 500

  Free text description for the subject

  Example: Screened subject
• dob: string (date-time)
  Date of birth
• enrollmentFailure: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for enrollment failure, if any

  Example: Consent withdrawn
• enrollmentOverride: string
  Minimum Length: 0

  Maximum Length: 255

  If subject enrollment is overridden.

  Example: Subject Enrollment Overridden
• eventType: string
  Event type name tracked for subject migration

  Example: MIGRATED
• gender: string
  Minimum Length: 0

  Maximum Length: 10

  Gender value

  Example: [{"value":"1","label":"male"}]
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the subject

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• informedConsentDate: string (date-time)
  Informed consent date

  Example: 2025-09-25T09:00:00Z
• objectVersionNumber: number
  Object version number

  Example: 9
• randomizationNumber: string
  Randomization number assigned post migration.

  Example: RND-123
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for latest subject update

  Example: Protocol break happened
• screeningDate: string (date-time)
  Screening date if applicable

  Example: 2025-10-01T10:00:00Z
• screeningFailure: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for screening failure, if any

  Example: Inclusion criteria not met
• siteId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

  Example: ABCDEF1234567890ABCDEF1234567890
• sourceTimeStamp: string (date-time)
  Timestamp when the subject was migrated or synchronized

  Example: 2025-12-01T10:30:51Z
• state(required): string
  Minimum Length: 0

  Maximum Length: 100

  Lifecycle state of the subject.The state can be New, Active, Screening_Initiated, Screen_Failed, Withdrawn, Auto_Screen_Failed, Complete or Enrolled.

  Example: Active
• stateDate: string (date-time)
  Timestamp when the subject transitioned to current state

  Example: 2025-10-16T14:30:31.892Z
• studyId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example: ABCDEF1234567890ABCDEF1234567890
• studyVersion(required): string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 3.0.0.1
• subjectNumber(required): string
  Minimum Length: 0

  Maximum Length: 500

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

  Example: SUBJ-0001
• subjectTransferId: string
  UUID of subject transfer record (if subject was transferred)

  Example: 1234567890ABCDEF1234567890ABCDEF
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2025-10-16T14:30:31.892Z

{
    "required":[
        "state",
        "studyVersion",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "screeningDate":{
            "type":"string",
            "description":"Screening date if applicable",
            "format":"date-time",
            "example":"2025-10-01T10:00:00Z"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number",
            "example":9
        },
        "eventType":{
            "type":"string",
            "description":"Event type name tracked for subject migration",
            "example":"MIGRATED"
        },
        "subjectTransferId":{
            "type":"string",
            "description":"UUID of subject transfer record (if subject was transferred)",
            "example":"1234567890ABCDEF1234567890ABCDEF"
        },
        "randomizationNumber":{
            "type":"string",
            "description":"Randomization number assigned post migration.",
            "example":"RND-123"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the subject",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "description":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Free text description for the subject",
            "example":"Screened subject"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Unique subject Number representing the patient/participant enrolled in the study.",
            "example":"SUBJ-0001"
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "dob":{
            "type":"string",
            "description":"Date of birth",
            "format":"date-time"
        },
        "state":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Lifecycle state of the subject.The state can be New, Active, Screening_Initiated, Screen_Failed, Withdrawn, Auto_Screen_Failed, Complete or Enrolled.",
            "example":"Active"
        },
        "stateDate":{
            "type":"string",
            "description":"Timestamp when the subject transitioned to current state",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "screeningFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for screening failure, if any",
            "example":"Inclusion criteria not met"
        },
        "enrollmentFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for enrollment failure, if any",
            "example":"Consent withdrawn"
        },
        "enrollmentOverride":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"If subject enrollment is overridden.",
            "example":"Subject Enrollment Overridden"
        },
        "informedConsentDate":{
            "type":"string",
            "description":"Informed consent date",
            "format":"date-time",
            "example":"2025-09-25T09:00:00Z"
        },
        "gender":{
            "maxLength":10,
            "minLength":0,
            "type":"string",
            "description":"Gender value",
            "example":"[{\"value\":\"1\",\"label\":\"male\"}]"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for latest subject update",
            "example":"Protocol break happened"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment for latest subject update",
            "example":"Initial enrollment"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "sourceTimeStamp":{
            "type":"string",
            "description":"Timestamp when the subject was migrated or synchronized",
            "format":"date-time",
            "example":"2025-12-01T10:30:51Z"
        }
    },
    "description":"Response payload for subject migration, including audit trail, object/version, subject event and randomization number"
}

Examples

Select an example Response after successful migration Example

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