1. REST API for Clinical One Platform
  2. Tasks
  3. Data Capture
  4. Visits Status
  5. Get list of visits' start dates for subjects

V1.0

post

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/visits/subjectvisitsinfo

Retrieves a list of visits' start dates for subjects, as well as the subject number and randomization number.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Request payload to retrieve subject visit information with specific events and instances.
Show Source
Nested Schema : subjects
Type: array
List of subjects with requested visit details.
Show Source
Example:
[
    {
        "subjectId":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
        "visits":[
            {
                "eventId":"53915DD9B758466AB2226CBCC4466B7E",
                "eventInstanceNum":1
            }
        ]
    }
]
Nested Schema : SubjectVisitsInfoReq
Type: object
Subject with optional visit filters for retrieving visit information.
Show Source
Example:
[
    {
        "subjectId":"1BC29B36F5D64B1B95F4BDBBCEA481BE",
        "visits":[
            {
                "eventId":"53915DD9B758466AB2226CBCC4466B7E",
                "eventInstanceNum":1
            }
        ]
    }
]
Nested Schema : visits
Type: array
Requested visit detail filters for this subject
Show Source
Example:
[
    {
        "eventId":"53915DD9B758466AB2226CBCC4466B7E",
        "eventInstanceNum":1
    }
]
Nested Schema : VisitInfoDetailReq
Type: object
Requested visit detail including event identifier and optional instance number.
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: 53915DD9B758466AB2226CBCC4466B7E
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
Example:
[
    {
        "eventId":"53915DD9B758466AB2226CBCC4466B7E",
        "eventInstanceNum":1
    }
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : SubjectVisitInfoResponse
Type: object
Show Source
Nested Schema : subjects
Type: array
Show Source
Nested Schema : SubjectVisitInfo
Type: object
Subject level visit information including subject identifiers and visit details.
Show Source
  • Screening number captured for the subject
    Example: SCR-0001
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: A1B2C3D4E5F6471890ABCDEF12345678
  • Unique subject Number representing the patient/participant enrolled in the study.
    Example: SUBJ-001
  • visits
    List of visit details for the subject
Nested Schema : visits
Type: array
List of visit details for the subject
Show Source
Example:
[
    {
        "eventId":"53915DD9B758466AB2226CBCC4466B7E",
        "eventInstanceNum":1,
        "visitStartDate":"2023-01-01T09:00:00Z"
    }
]
Nested Schema : VisitInfoDetail
Type: object
Visit detail containing event identifier, optional instance number, and optional start date.
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: 53915DD9B758466AB2226CBCC4466B7E
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • Date of visit
    Example: 2023-01-01T09:00:00Z
Example:
[
    {
        "eventId":"53915DD9B758466AB2226CBCC4466B7E",
        "eventInstanceNum":1,
        "visitStartDate":"2023-01-01T09:00:00Z"
    }
]
Examples

400 Response

Bad request.
Body ()
Root Schema : DcsResponse
Type: object
Show Source
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
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
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