REST API for Clinical One Platform

~~[Deprecated]: Update visit status for a given ID~~

put

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

Deprecated: Updates the visit status record for a given ID.

Request

Path Parameters

mode(required): string

Mode of the study. Accepts test, active, or training.
studyId(required): string

ID of the study for which you want to get the list of subjects.
visitStatusId(required): string

Visit ID to update.

Supported Media Types

application/json

Root Schema : schema

Type: object

Base visit status information including identity, study metadata and status fields

Show Source

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
id: string (uuid)

Unique identifier of the visit status record
reason: string

Minimum Length: 0

Maximum Length: 255

Reason associated with the visit status

Example: Subject completed the visit successfully
siteId: string

Site identifier in uppercase hex format

Example: ABCDEF1234567890ABCDEF1234567890
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)
versionStart: string (date-time)

Start timestamp of the version record

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

Visit start date timestamp

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

Status of the visit as per VisitsStatusEnum

Example: COMPLETED

{
    "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"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Visit start date timestamp",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        }
    },
    "description":"Base visit status information including identity, study metadata and status fields"
}

Response

Supported Media Types

application/json

200 Response

Subjects success.

Root Schema : VisitsStatus

Type: object

Show Source

associatedStudyVersion: string

Minimum Length: 0

Maximum Length: 100
comment: string

Minimum Length: 0

Maximum Length: 2048
display: string
doseHoldAction: string
dynamicAllCycles: string
eventId: string
eventInstanceNum: integer (int32)
eventType: string
freezedStatus: string
id: string (uuid)
leadingDataelementId: string
lockedDateTime: string (date-time)
lockedStatus: string
operationType: string

Minimum Length: 1

Maximum Length: 16
reason: string

Minimum Length: 0

Maximum Length: 255
repeatingFormCount: number
scheduledDate: string (date-time)
scheduledEndDate: string (date-time)
scheduledFromEventGUID: string
scheduledStartDate: string (date-time)
scheduledWindowEndDate: string (date-time)
scheduledWindowStartDate: string (date-time)
signedStatus: string
siteId: string
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100
subjectId: string
userId: string (uuid)
verifiedStatus: string
versionStart: string (date-time)
visitAction: string
visitStartDate: string (date-time)
visitStartDateLockedDateTime: string (date-time)
visitStartDateLockedStatus: string
visitStatus: string
visitType: string
visitWindowWarning: string

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "visitStatus":{
            "type":"string"
        },
        "visitStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "visitType":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "associatedStudyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "leadingDataelementId":{
            "type":"string"
        },
        "dynamicAllCycles":{
            "type":"string"
        },
        "visitWindowWarning":{
            "type":"string"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledFromEventGUID":{
            "type":"string"
        },
        "repeatingFormCount":{
            "type":"number"
        },
        "signedStatus":{
            "type":"string"
        },
        "lockedStatus":{
            "type":"string"
        },
        "visitStartDateLockedStatus":{
            "type":"string"
        },
        "lockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "visitStartDateLockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "doseHoldAction":{
            "type":"string"
        },
        "visitAction":{
            "type":"string"
        }
    }
}

400 Response

Bad request.

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