Jump to

• Request
• Response

V10.0

get

/ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/subjects/{subjectId}/visitWindowInfo/{visitId}

Returns visit window details for the specified subject and visit

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:

  0A1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D

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

  Example:

  BABA5F5A7F48455BAC61D2B9337C2F48

• visitId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

  Example:

  F5B35F6A8B7C4ED6B0A63D2B9A7E227F

Query Parameters

• 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

• requiredVisit: string
  Flag indicating if only required visits should be included. Example: Y for required, N for all.

  Example:

  Y

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful response. Returns the visit window information for the specified subject and visit.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object VisitWindowInfoDTO
  DTO containing detailed visit window information for a subject's visit schedule in a study, including event and visit identifier, dates and flags.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/VisitWindowInfoDTO"
    }
}

Nested Schema : VisitWindowInfoDTO

Type: object

DTO containing detailed visit window information for a subject's visit schedule in a study, including event and visit identifier, dates and flags.

Show Source

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

  Example: 0A1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D
• 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
• isSkipped: boolean
  Flag indicating if the visit was skipped.

  Example: false
• scheduledDate: string (date-time)
  Start date/time of the schedule for the visit

  Example: 2025-11-05T10:00:00Z
• scheduledWindowEndDate: string (date-time)
  End date/time of the scheduled window for the visit.

  Example: 2025-11-10T17:00:00Z
• scheduledWindowStartDate: string (date-time)
  Start date/time of the scheduled window for the visit.

  Example: 2025-11-01T08:00:00Z
• visitName: string
  Name of the visit as defined in the protocol.

  Example: Screening

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"0A1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D"
        },
        "visitName":{
            "type":"string",
            "description":"Name of the visit as defined in the protocol.",
            "example":"Screening"
        },
        "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
        },
        "scheduledDate":{
            "type":"string",
            "description":"Start date/time of the schedule for the visit",
            "format":"date-time",
            "example":"2025-11-05T10:00:00Z"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "description":"Start date/time of the scheduled window for the visit.",
            "format":"date-time",
            "example":"2025-11-01T08:00:00Z"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "description":"End date/time of the scheduled window for the visit.",
            "format":"date-time",
            "example":"2025-11-10T17:00:00Z"
        },
        "isSkipped":{
            "type":"boolean",
            "description":"Flag indicating if the visit was skipped.",
            "example":false
        }
    },
    "description":"DTO containing detailed visit window information for a subject's visit schedule in a study, including event and visit identifier, dates and flags."
}

Examples

Select an example VisitWindowInfoDTO List 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