REST API for Clinical One Platform

V8.0

get

/ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}

Retrieves the audit history records of the visit statuses for the given visit ID with additional information on states of visit start date. This API also provides unscheduled events in response.

Request

Path Parameters

mode(required): string
Mode of the study, accepts: test, active, or training.
Example:
```
test
```
studyId(required): string
Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
Example:
```
3F2504E04F8911D39A0C0305E82C3301
```
visitsStatusId(required): string(uuid)
Visit ID for which you want to retrieve the history.The format should be UUID, 32-character uppercase hexadecimal string
Example:
```
53915DD9B758466AB2226CBCC4466B7E
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Subjects success.

Root Schema : schema

Type: array

Show Source

Array of: object VisitsStatusDto810

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

Nested Schema : VisitsStatusDto810

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048

Additional comment for the visit status

Example: All data verified
eventId: string

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

Example: ABCDEF1234567890ABCDEF1234567890
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
eventType: string

Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.

Example: Visit_Not_Started
freezedStatus: string

Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.

Example: FROZEN
id: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
lockedDateTime: string (date-time)

Timestamp when the visit was locked

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

Locked status of the visit. Can have values LOCKED,UNLOCKED or NEVER_LOCKED

Example: LOCKED
reason: string

Minimum Length: 0

Maximum Length: 255

Reason associated with the visit status

Example: Subject completed the visit successfully
signedStatus: string

Signed status for workflow, the acceptable values are: NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.

Example: SIGNED
siteId: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

Example: ABCDEF1234567890ABCDEF1234567890
sourceTimeStamp: string (date-time)

Timestamp from the source system indicating when this record originated

Example: 2025-10-16T14:30:31.892Z
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100

String representing the version of the study configuration or protocol. Helps track changes in form or study design.

Example: 3.0.0.1
subjectId: string

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

Example: ABCDEF1234567890ABCDEF1234567890
verifiedStatus: string

Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.

Example: VERIFIED
versionStart: string

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

Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.

Example: LOCKED
visitStartDateLockedDateTime: string (date-time)

Timestamp when the visit start date was locked

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

Action performed on visit start date LOCKED, UNLOCKED, NEVER_LOCKED.

Example: LOCKED
visitStartDateSignStatus: string

Signed status for workflow, the acceptable values are: NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.

Example: SIGNED
visitStartDateVerifyStatus: string

Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.

Example: VERIFY
visitStatus: string

Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.

Example: COMPLETE
visitType: string

Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.

Example: SCREENING

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"Start timestamp of the version record",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "visitStatus":{
            "type":"string",
            "description":"Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.",
            "example":"COMPLETE"
        },
        "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"
        },
        "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. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.",
            "example":"SCREENING"
        },
        "eventType":{
            "type":"string",
            "description":"Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.",
            "example":"Visit_Not_Started"
        },
        "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
        },
        "signedStatus":{
            "type":"string",
            "description":"Signed status for workflow, the acceptable values are:  NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.",
            "example":"SIGNED"
        },
        "verifiedStatus":{
            "type":"string",
            "description":"Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.",
            "example":"VERIFIED"
        },
        "freezedStatus":{
            "type":"string",
            "description":"Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.",
            "example":"FROZEN"
        },
        "sourceTimeStamp":{
            "type":"string",
            "description":"Timestamp from the source system indicating when this record originated",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "lockedStatus":{
            "type":"string",
            "description":"Locked status of the visit. Can have values LOCKED,UNLOCKED or NEVER_LOCKED",
            "example":"LOCKED"
        },
        "lockedDateTime":{
            "type":"string",
            "description":"Timestamp when the visit was locked",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "visitStartDateLockedStatus":{
            "type":"string",
            "description":"Action performed on visit start date LOCKED, UNLOCKED, NEVER_LOCKED.",
            "example":"LOCKED"
        },
        "visitStartDateLockedDateTime":{
            "type":"string",
            "description":"Timestamp when the visit start date was locked",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "visitStartDateFreezeStatus":{
            "type":"string",
            "description":"Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.",
            "example":"LOCKED"
        },
        "visitStartDateVerifyStatus":{
            "type":"string",
            "description":"Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.",
            "example":"VERIFY"
        },
        "visitStartDateSignStatus":{
            "type":"string",
            "description":"Signed status for workflow, the acceptable values are:  NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.",
            "example":"SIGNED"
        }
    }
}

Examples

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData
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

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Examples