REST API for Clinical One Platform

~~[Deprecated]: Get list of visits status~~

get

/ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/visitstatus

Deprecated: Retrieves the list of visit statuses for a visit. If the event ID is null, then it lists all the visit statuses records for a subject.This API also provides unscheduled events details. API has been deprecated and moved to DIS (Data Integration Service), Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visitstatus

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.

Query Parameters

eventId(required): string

Visit ID for Designer.
eventInstanceNumber: integer(int32)

Unscheduled event instance number.
subjectId(required): string

Subject ID.
updateStatus: boolean

Reevaluates the visit status with the current design, if set to true.

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 VisitsStatus

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

Nested 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

Title: ErrorResponseData

Error Response Details Information
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

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.