Jump to

• Request
• Response

V1.0

post

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/validate/multiplevisits

Provides the summary for the multiple visits and returns the actions of visit and visitStartDate.

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:

  B1D8B2BA9DD84F0BAEF700387265AC8A

• subjectId(required): string(uuid)
  Unique subject identifier representing the patient/participant enrolled in the study.

  Example:

  FE647AE28C394F3BA1C9701045D1C4F8

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request DTO with a list of VisitsDTO objects for validating visit start dates across multiple visits.

Show Source

• visits(required): array visits
  The list of visit objects to validate.

{
    "required":[
        "visits"
    ],
    "type":"object",
    "properties":{
        "visits":{
            "type":"array",
            "description":"The list of visit objects to validate.",
            "items":{
                "$ref":"#/components/schemas/VisitsDTO1"
            }
        }
    },
    "description":"Request DTO with a list of VisitsDTO objects for validating visit start dates across multiple visits."
}

Nested Schema : visits

Type: array

The list of visit objects to validate.

Show Source

• Array of: object VisitsDTO1
  Takes eventId and eventInstanceNum to uniquely reference a visit instance

{
    "type":"array",
    "description":"The list of visit objects to validate.",
    "items":{
        "$ref":"#/components/schemas/VisitsDTO1"
    }
}

Nested Schema : VisitsDTO1

Type: object

Takes eventId and eventInstanceNum to uniquely reference a visit instance

Show Source

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

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

  Example: 1

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "format":"UUID",
            "example":"D27DB9E0AFE349D7980683CF55A33883"
        },
        "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":"int64",
            "example":1
        }
    },
    "description":"Takes eventId and eventInstanceNum to uniquely reference a visit instance"
}

Examples

Select an example MultipleVisitRequestBody

Back to Top

Response

Supported Media Types

• application/json

200 Response

Visit start dates validated, results for each visit returned as array.

Body ()

Root Schema : VisitStartDateValidationDto

Type: object

Includes subjectId, eventId, eventInstanceNum, and boolean results indicating whether the visit and the visit start date are locked

Show Source

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

  Example: B1ABA3F2E29F4EE193AB6A5DEEC1B5CA
• 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: 5
• subjectId: string (UUID)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example: A1B2C3D4E5F60718293A4BCCFA7EE829
• visitLocked: boolean
  Whether the visit is locked.

  Example: false
• visitStartDateLocked: boolean
  Whether the visit start date is locked.

  Example: true

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "format":"UUID",
            "example":"A1B2C3D4E5F60718293A4BCCFA7EE829"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "format":"UUID",
            "example":"B1ABA3F2E29F4EE193AB6A5DEEC1B5CA"
        },
        "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":5
        },
        "visitStartDateLocked":{
            "type":"boolean",
            "description":"Whether the visit start date is locked.",
            "example":true
        },
        "visitLocked":{
            "type":"boolean",
            "description":"Whether the visit is locked.",
            "example":false
        }
    },
    "description":"Includes subjectId, eventId, eventInstanceNum, and boolean results indicating whether the visit and the visit start date are locked"
}

Examples

Select an example VisitStartDateValidationArrayResponse

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