REST API for Clinical One Platform

Get list of visits status for subjects

post

/ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/subjects

Retrieves a list of visits status for subjects, as well as the study version associated with each visit status. This API request also lists unscheduled event details.Now supports query param cycleCountToDate for filtering by scheduled date for cycles

Request

Path Parameters

studyId(required): string

ID of the study for which you want to get the list of subjects.

Query Parameters

cycleCountToDate: string(date-time)
nextVisitOnly: boolean
notStarted: boolean
signVerifyStatus(required): string

Status of Sign / Verify.

Default Value: ALL
siteId: string
siteStudyVersion: string

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

subjects: array subjects

{
    "type":"object",
    "properties":{
        "subjects":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : subjects

Type: array

Show Source

Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object SubjectVisitsDto90

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

Nested Schema : SubjectVisitsDto90

Type: object

Show Source

canBeCompleted: boolean
crntStateStudyVrsn: string
freezedStatus: string
lastSigned: string
lockedInStudyVersion: string
lockedStatus: string
scheduledVisits: array scheduledVisits
signedStatus: string
subjectId: string
verifiedStatus: string
visits: array visits

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string"
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitsStatusDto12"
            }
        },
        "scheduledVisits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ScheduledVisitsDto"
            }
        },
        "crntStateStudyVrsn":{
            "type":"string"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "lastSigned":{
            "type":"string"
        },
        "lockedStatus":{
            "type":"string"
        },
        "canBeCompleted":{
            "type":"boolean"
        },
        "lockedInStudyVersion":{
            "type":"string"
        }
    }
}

Nested Schema : scheduledVisits

Type: array

Show Source

Array of: object ScheduledVisitsDto

Base scheduled visit details including scheduling windows and identifiers

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

Nested Schema : visits

Type: array

Show Source

Array of: object VisitsStatusDto12

Visit status details including lock status and lock timestamps

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

Nested Schema : ScheduledVisitsDto

Type: object

Base scheduled visit details including scheduling windows and identifiers

Show Source

cycleCount: number (int32)

Cycle count for the visit

Example: 1
eventId: string

Identifier of the visit event

Example: ADF5A7800A954FA5B831E7B6B9CA39A9
eventInstanceNum: number (int32)

Unscheduled/cycle visit instance number when applicable

Example: 1
scheduledDate: string (date-time)

Scheduled date for the visit

Example: 2025-10-12T14:30:31.892Z
scheduledWindowEndDate: string (date-time)

Window end date for scheduling the visit

Example: 2025-10-20T14:30:31.892Z
scheduledWindowStartDate: string (date-time)

Window start date for scheduling the visit

Example: 2025-10-10T14:30:31.892Z
title: string

Display title for the visit

Example: Baseline

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Identifier of the visit event",
            "example":"ADF5A7800A954FA5B831E7B6B9CA39A9"
        },
        "title":{
            "type":"string",
            "description":"Display title for the visit",
            "example":"Baseline"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "description":"Window start date for scheduling the visit",
            "format":"date-time",
            "example":"2025-10-10T14:30:31.892Z"
        },
        "scheduledDate":{
            "type":"string",
            "description":"Scheduled date for the visit",
            "format":"date-time",
            "example":"2025-10-12T14:30:31.892Z"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "description":"Window end date for scheduling the visit",
            "format":"date-time",
            "example":"2025-10-20T14:30:31.892Z"
        },
        "eventInstanceNum":{
            "type":"number",
            "description":"Unscheduled/cycle visit instance number when applicable",
            "format":"int32",
            "example":1
        },
        "cycleCount":{
            "type":"number",
            "description":"Cycle count for the visit",
            "format":"int32",
            "example":1
        }
    },
    "description":"Base scheduled visit details including scheduling windows and identifiers"
}

Nested Schema : VisitsStatusDto12

Type: object

Visit status details including lock status and lock timestamps

Show Source

associatedStudyVersion: string

Study version with which the visit status is associated

Example: 3.0.0.1
comment: string

Minimum Length: 0

Maximum Length: 2048

Additional comment for the visit status

Example: All data verified
eventId: string

Event identifier in uppercase hex format

Example: ABCDEF1234567890ABCDEF1234567890
eventInstanceNum: integer (int32)

Unscheduled/cycle visit instance number when applicable.

Example: 1
eventType: string

Event type corresponding to the visit

Example: Visit_Not_Started
freezedStatus: string

Freeze status of the visit

Example: FROZEN
id: string (uuid)

Unique identifier of the visit status record
lockedDateTime: string (date-time)

Timestamp when the visit was locked

Example: 2025-10-16T14:30:31.892Z
lockedStatus: string

Locked status of the visit

Example: UNLOCKED
objectVersionNumber: number

Object version number used for concurrency control

Example: 14
operationType: string
reason: string

Minimum Length: 0

Maximum Length: 255

Reason associated with the visit status

Example: Subject completed the visit successfully
repeatingFormCount: number

Number of repeating form instances for the visit

Example: 2
scheduledWindowEndDate: string (date-time)

Scheduled window end date for the visit

Example: 2025-10-16T14:30:31.892Z
scheduledWindowStartDate: string (date-time)

Scheduled window start date for the visit

Example: 2025-10-16T14:30:31.892Z
signedStatus: string

Signed status of the visit

Example: SIGNED
siteId: string

Site identifier in uppercase hex format

Example: ABCDEF1234567890ABCDEF1234567890
softwareVersionNumber: number
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100

Study version string under which the visit is recorded

Example: 3.0.0.1
subjectId: string

Subject identifier in uppercase hex format

Example: ABCDEF1234567890ABCDEF1234567890
userId: string (uuid)
verifiedStatus: string

Verified status of the visit

Example: VERIFIED
versionEnd: string (date-time)
versionStart: string (date-time)

Start timestamp of the version record

Example: 2025-10-16T14:30:31.892Z
visitAction: string

Action to be taken for the visit

Example: SCREEN_DISABLE
visitStartDate: string (date-time)

Visit start date timestamp

Example: 2025-10-16T14:30:31.892Z
visitStartDateLockedDateTime: string (date-time)

Timestamp when the visit start date was locked

Example: 2025-10-16T14:30:31.892Z
visitStartDateLockedStatus: string

Locked status for the visit start date

Example: UNLOCKED
visitStatus: string

Status of the visit as per VisitsStatusEnum

Example: COMPLETED
visitType: string

Type of visit as per the visit type enumeration

Example: Screening Visit

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the visit status record",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Start timestamp of the version record",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "subjectId":{
            "type":"string",
            "description":"Subject identifier in uppercase hex format",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "eventId":{
            "type":"string",
            "description":"Event identifier in uppercase hex format",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Site identifier in uppercase hex format",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Study version string under which the visit is recorded",
            "example":"3.0.0.1"
        },
        "visitStatus":{
            "type":"string",
            "description":"Status of the visit as per VisitsStatusEnum",
            "example":"COMPLETED"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason associated with the visit status",
            "example":"Subject completed the visit successfully"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment for the visit status",
            "example":"All data verified"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number used for concurrency control",
            "example":14
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Visit start date timestamp",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "visitType":{
            "type":"string",
            "description":"Type of visit as per the visit type enumeration",
            "example":"Screening Visit"
        },
        "eventType":{
            "type":"string",
            "description":"Event type corresponding to the visit",
            "example":"Visit_Not_Started"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Unscheduled/cycle visit instance number when applicable.",
            "format":"int32",
            "example":1
        },
        "signedStatus":{
            "type":"string",
            "description":"Signed status of the visit",
            "example":"SIGNED"
        },
        "verifiedStatus":{
            "type":"string",
            "description":"Verified status of the visit",
            "example":"VERIFIED"
        },
        "freezedStatus":{
            "type":"string",
            "description":"Freeze status of the visit",
            "example":"FROZEN"
        },
        "repeatingFormCount":{
            "type":"number",
            "description":"Number of repeating form instances for the visit",
            "example":2
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "description":"Scheduled window start date for the visit",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "description":"Scheduled window end date for the visit",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "associatedStudyVersion":{
            "type":"string",
            "description":"Study version with which the visit status is associated",
            "example":"3.0.0.1"
        },
        "visitAction":{
            "type":"string",
            "description":"Action to be taken for the visit",
            "example":"SCREEN_DISABLE"
        },
        "lockedStatus":{
            "type":"string",
            "description":"Locked status of the visit",
            "example":"UNLOCKED"
        },
        "visitStartDateLockedStatus":{
            "type":"string",
            "description":"Locked status for the visit start date",
            "example":"UNLOCKED"
        },
        "lockedDateTime":{
            "type":"string",
            "description":"Timestamp when the visit was locked",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "visitStartDateLockedDateTime":{
            "type":"string",
            "description":"Timestamp when the visit start date was locked",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        }
    },
    "description":"Visit status details including lock status and lock timestamps"
}

400 Response

Bad request.

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: string

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
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":"string",
            "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