Jump to

• Request
• Response

V1.0

post

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

Persists migrated visit data.

Request

Path Parameters

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

  Example:

  test

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

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request payload to migrate visit data for a subject and event. Contains identifiers and timestamps.

Show Source

• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example: 53915DD9B758466AB2226CBCC4466B7E
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

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

  Example: 8F2B7E6C5D4A3B2C1D0E9F8A7B6C5D4E
• sourceTimeStamp: string (date-time)
  Source system timestamp in ISO 8601 UTC

  Example: 2023-01-01T09:00:00Z
• studyVersion: string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

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

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• visitStartDate: string (date-time)
  Visit start date-time in ISO 8601 UTC

  Example: 2023-01-01T09:00:00Z
• visitStatus: string
  Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.

  Example: COMPLETE

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"53915DD9B758466AB2226CBCC4466B7E"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"8F2B7E6C5D4A3B2C1D0E9F8A7B6C5D4E"
        },
        "visitStatus":{
            "type":"string",
            "description":"Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.",
            "example":"COMPLETE"
        },
        "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"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Visit start date-time in ISO 8601 UTC",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        },
        "sourceTimeStamp":{
            "type":"string",
            "description":"Source system timestamp in ISO 8601 UTC",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        }
    },
    "description":"Request payload to migrate visit data for a subject and event. Contains identifiers and timestamps."
}

Examples

Select an example VisitDataMigrationRequestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : VisitDataMigrationDtoV1

Type: object

Visit data migration payload/response containing identity, versioning, visit status and timing fields.

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Comment

  Example: All data verified
• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example: 53915DD9B758466AB2226CBCC4466B7E
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example: 1
• eventType: string
  Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.

  Example: Visit_Not_Started
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record

  Example: A1B2C3D4E5F6471890ABCDEF12345678
• objectVersionNumber: number
  Object version number used for concurrency control.

  Example: 14
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason

  Example: Subject completed the visit successfully
• siteId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

  Example: 8F2B7E6C5D4A3B2C1D0E9F8A7B6C5D4E
• sourceTimeStamp: string (date-time)
  Source timestamp when the record was generated in the source system

  Example: 2023-01-01T09:00:00Z
• studyVersion: string
  Minimum Length: 0

  Maximum Length: 100

  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

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

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• userId: string
  Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user

  Example: 9F8E7D6C5B4A3A2B1C0D9E8F7A6B5C4D
• 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
• visitStartDate: string (date-time)
  Date of visit

  Example: 2023-01-01T09:00:00Z
• visitStatus: string
  Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.

  Example: COMPLETE
• visitType: string
  Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.

  Example: SCREENING

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record",
            "example":"A1B2C3D4E5F6471890ABCDEF12345678"
        },
        "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"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"53915DD9B758466AB2226CBCC4466B7E"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "visitType":{
            "type":"string",
            "description":"Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.",
            "example":"SCREENING"
        },
        "eventType":{
            "type":"string",
            "description":"Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.",
            "example":"Visit_Not_Started"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"8F2B7E6C5D4A3B2C1D0E9F8A7B6C5D4E"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "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"
        },
        "visitStatus":{
            "type":"string",
            "description":"Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.",
            "example":"COMPLETE"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason",
            "example":"Subject completed the visit successfully"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment",
            "example":"All data verified"
        },
        "userId":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user",
            "example":"9F8E7D6C5B4A3A2B1C0D9E8F7A6B5C4D"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number used for concurrency control.",
            "example":14
        },
        "sourceTimeStamp":{
            "type":"string",
            "description":"Source timestamp when the record was generated in the source system",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Date of visit",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        }
    },
    "description":"Visit data migration payload/response containing identity, versioning, visit status and timing fields."
}

Examples

Select an example VisitDataMigrationDtoV1Example

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