Jump to

• Request
• Response

Add a subject as migartion

post

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

Adds or migrates a subject to a study using subject migartion API with sourceTimeStamp value. This API has been built without any validations. API expects the Subject Number provided as part of payload to match exactly the Subject Number settings. API also expect sourceTimeStamp value as part of payload. It ignores the Subject Number Settings and creates the Subject with Subject Number provided as part of payload. Caller needs to ensure it provides Site Prefix, hyphen, leading zeros and any pattern defined as part of Subject Number Settings. Rights: MigrationDataPost.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts test, active, or training.
• studyId(required): string
  ID of the study for which you want to get the list of subjects.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• subject: object SubjectMigrationRequestDTO

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

Nested Schema : SubjectMigrationRequestDTO

Type: object

Show Source

• siteId: string (uuid)
• sourceTimeStamp: string (date-time)
• state: string
  Minimum Length: 0

  Maximum Length: 100
• subjectNumber: string
  Minimum Length: 0

  Maximum Length: 500

{
    "type":"object",
    "properties":{
        "subjectNumber":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        },
        "siteId":{
            "type":"string",
            "format":"uuid"
        },
        "state":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "sourceTimeStamp":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

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

400 Response

Bad request.

Body ()

Root Schema : SubjectMigrationResponseDTO

Type: object

Show Source

• codeBreak: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• description: string
  Minimum Length: 0

  Maximum Length: 500
• dob: string (date-time)
• enrollmentFailure: string
  Minimum Length: 0

  Maximum Length: 255
• enrollmentOverride: string
  Minimum Length: 0

  Maximum Length: 255
• eventType: string
• gender: string
  Minimum Length: 0

  Maximum Length: 10
• id: string (uuid)
• informedConsentDate: string (date-time)
• objectVersionNumber: number
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• screeningDate: string (date-time)
• screeningFailure: string
  Minimum Length: 0

  Maximum Length: 255
• siteId: string
• sourceTimeStamp: string (date-time)
• state: string
  Minimum Length: 0

  Maximum Length: 100
• stateDate: string (date-time)
• studyId: string
• studyVersion: string
• subjectNumber: string
  Minimum Length: 0

  Maximum Length: 500
• subjectTransferId: string (uuid)
• userId: string (uuid)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "screeningDate":{
            "type":"string",
            "format":"date-time"
        },
        "codeBreak":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "eventType":{
            "type":"string"
        },
        "subjectTransferId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "description":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        },
        "subjectNumber":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "dob":{
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "stateDate":{
            "type":"string",
            "format":"date-time"
        },
        "screeningFailure":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "enrollmentFailure":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "enrollmentOverride":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "informedConsentDate":{
            "type":"string",
            "format":"date-time"
        },
        "gender":{
            "maxLength":"10",
            "minLength":"0",
            "type":"string"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "sourceTimeStamp":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Back to Top